Axuz Developers

POST /teams/{teamId}/flowcharts/import-db-schema

Introspeciona schema de DB e devolve FlowDocument.

  • Acesso: Membro da equipe
  • Serviço: https://api-flow.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

Suporta MySQL + Postgres. Guardas SSRF em IPs privados. 501 quando o build não tem dialect drivers linkados.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
dialectstringsim

enum: "mysql", "postgres"

hoststringsim
portintegernão
dbstringsim
userstringsim
passwordstring<password>não
{
  "dialect": "mysql",
  "host": "string",
  "port": 1,
  "db": "string",
  "user": "string",
  "password": "string"
}

Respostas

200

Schema convertido em FlowDocument.

NomeTipoObrigatórioDescrição
nodesarray<FlowNode>sim
nodes[].idstringsim
nodes[].typestringsim
nodes[].positionFlowXYsim
nodes[].position.xnumbersim
nodes[].position.ynumbersim
nodes[].widthinteger | nullnão
nodes[].heightinteger | nullnão
nodes[].parentNodestringnão
nodes[].extentstringnão
nodes[].dataobjectsim
nodes[].styleobjectnão
edgesarray<FlowEdge>sim
edges[].idstringsim
edges[].sourcestringsim
edges[].targetstringsim
edges[].typestringnão
edges[].dataobjectnão

400

Payload inválido.

NomeTipoObrigatórioDescrição
errorstringsim

401

JWT ausente/expirado.

NomeTipoObrigatórioDescrição
errorstringsim

403

Host resolve pra IP privado (SSRF guard).

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

501

Dialect drivers não linkados no build.

NomeTipoObrigatórioDescrição
errorstringsim

502

Falha ao conectar / introspectar DB alvo.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X POST 'https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/import-db-schema' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"dialect":"mysql","host":"string","port":1,"db":"string","user":"string","password":"string"}'

Node.js

const res = await fetch("https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/import-db-schema", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "dialect": "mysql",
    "host": "string",
    "port": 1,
    "db": "string",
    "user": "string",
    "password": "string"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/import-db-schema",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "dialect": "mysql",
        "host": "string",
        "port": 1,
        "db": "string",
        "user": "string",
        "password": "string",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())