Crie integrações sem abrir o ERP

1. Como o Hub se organiza

O Hub separa cada responsabilidade para evitar que uma credencial ou uma consulta vire acesso irrestrito. A interface usa nomes simples, mas internamente os vínculos permanecem explícitos.

2. API Studio

O API Studio é a área principal para criar, agrupar, testar, versionar e publicar contratos. A visão padrão é por API/recurso, não por tabelas técnicas separadas.

Lista de APIs

Use pesquisa e filtros para localizar por rota, operação, recurso, conexão ou scope. APIs ficam agrupadas por recurso. O botão Gerenciar abre contrato, consulta, mapeamento, teste, credenciais, revisões e publicação no mesmo contexto.

3. Importar script ou contrato

Use Importar script / contrato quando outro projeto já possui SQL ou uma especificação OpenAPI. A importação é assistida: ela cria um rascunho, nunca publica e nunca executa automaticamente.

Segurança da importação

• SQL importado passa pelo mesmo validador read-only.
• INSERT, UPDATE, DELETE, DDL e múltiplas instruções são rejeitados.
• Importar não significa homologar: a conexão, os parâmetros e o retorno ainda precisam ser testados.
• Não cole senhas, tokens ou strings de conexão dentro do script.

4. Parâmetros sem formulário gigante

Cada parâmetro aparece em uma linha compacta com valor de teste, origem, tipo e obrigatoriedade. Regras menos usadas ficam recolhidas em Mais regras.

5. Mapeamento e contrato de saída

O mapeamento é a barreira entre o nome físico da origem e o nome público. Se o ERP usa ITE_DESITE, a API pode publicar descricao. Uma troca de ERP não precisa quebrar os consumidores.

6. Credenciais e segurança

O método escolhido determina quais campos devem ser preenchidos. Client e Route precisam concordar: habilitar um método no Client não libera todas as rotas.

7. Catálogo e modelos reutilizáveis

O Catálogo é uma biblioteca de integrações. Um modelo descreve conexão, recursos, operações, rotas, Clients e orientações. Importar um modelo cria objetos em Homologação; URLs e credenciais reais continuam obrigatórias.

Ciclo do modelo

Criador de modelos

O criador visual permite identidade, conexão, endpoints e revisão. OpenAPI JSON pode preencher endpoints. Depois de uma versão aplicada, não altere o contrato histórico: crie uma nova versão.

8. Modelos do ecossistema TS

A versão 0.11.4 mantém e amplia modelos/contratos para os projetos que dependem do Hub. TS Labels já possui SQL AUTCOM/MySQL funcional para produto/código de barras e localização e exige a escolha da origem real durante a importação. Nos demais modelos, quando a estrutura física do ERP não é conhecida, o Hub mantém a operação em Homologação para mapeamento explícito em vez de inventar SQL.

9. Designer de fluxo

Use fluxo quando uma API precisa chamar várias operações, aplicar condição, transformar dados ou compor uma resposta. O Designer ocupa quase toda a tela, possui zoom, organização automática e inspector contextual.

Referências

$input.company
$input.codigo
$steps.consultar_produto.data
$steps.validar.result

Retry

Retry de uma operação é opt-in. Configure número de tentativas e intervalo somente quando repetir a chamada for seguro. O motor só repete falhas técnicas 5xx; não repete automaticamente erros de validação.

10. Homologar e publicar

1. Conexão/Target testado e ativo.
2. Consulta validada como read-only quando aplicável.
3. Parâmetros com valores reais de homologação e limites corretos.
4. JSON de saída revisado e sem campos indevidos.
5. Client criado, método de autenticação configurado e segredo tratado corretamente.
6. Scope da Route compatível com o Client.
7. Empresa/filial resolvida explicitamente.
8. Rate limit, lote e timeout definidos.
9. Teste da Operation executado.
10. Teste da Route executado com autenticação real.
11. Auditoria contém request_id e não contém secrets.
12. Somente então publique Operation e Route.

11. Diagnóstico rápido

Use sempre o Request ID para correlacionar teste, auditoria e log técnico. Em diagnóstico administrativo, detalhes técnicos podem aparecer sanitizados; nunca exponha segredos ao consumidor.

9. Editor de API 0.11.4

Ao editar uma API existente, o assistente começa pela origem/conexão. O Target exato fica visível nas etapas seguintes e pode ser testado ou trocado. O editor SQL detecta binds :nome em tempo real; valores de homologação, tipo e origem do parâmetro ficam juntos e as regras avançadas permanecem recolhidas.

No Catálogo → TS Labels, selecione o projeto e a Connection/Target AUTCOM/MySQL real. A importação grava essa origem na Operation e na Route, atualiza placeholders antigos e mantém tudo em Homologação até o teste real.

10. Diagnóstico e contrato TS Labels 0.11.4

O teste SQL informa resultado real da origem. Em caso de falha, o Studio mostra HTTP, código, etapa, mensagem, Request ID e detalhe técnico sanitizado. Para TS Labels, /v1/labels/product e /v1/labels/location são lookups de objeto único; pesquisas por descrição ou marca usam /v1/labels/product/search.

11. Acesso da API por Client

Credencial, secret e método de autenticação pertencem ao Client. A API/Route não cria nem rotaciona segredo. Em Acessos, selecione um ou vários Clients autorizados. Isso permite usar o mesmo endpoint com Clients diferentes por loja. O Hub mantém o scope necessário internamente quando o vínculo explícito é salvo.

Use o modo Somente Clients selecionados como padrão. O modo Qualquer Client do projeto com o scope fica disponível para cenários administrados por scope.