API & Desenvolvedores
1 min de leituraAtualizado em 22 out. de 2026

Visão Geral da API

Consulte a referência gerada da API para integrar os recursos realmente expostos.

Abrir no app

Como usar

  1. Abra a documentação pública e escolha módulo e operação.
  2. Confira método, parâmetros, corpo, respostas e escopo exigido.
  3. Crie uma chave apropriada e teste leitura antes de usar mutações ou envios.

Faça a primeira consulta pelo contrato atual

  • Em Documentação da API, pesquise recurso, rota ou permissão. Confira método, parâmetros e exemplos da operação escolhida.
  • Crie uma chave com acesso mínimo e teste uma leitura da sua empresa. Confira paginação antes de interpretar uma listagem como completa.
  • Só depois prepare alterações ou envios, conferindo o resultado no recurso de origem. Uma capacidade da interface não comprova um endpoint público equivalente.

Como conferir o resultado

  • O cliente usa o contrato publicado e consulta o resultado no recurso de origem.

Limites e cuidados

  • API, MCP e interface compartilham serviços, mas uma função da interface não implica endpoint público equivalente. Consulte a referência.

Se algo não funcionar

Não encontro a operação necessária
Consulte as opções realmente publicadas e suporte. Não invente uma rota a partir do nome de um botão.

Continuar no aplicativo

Este artigo resolveu sua dúvida?

Sua avaliação ajuda a priorizar revisões de conteúdo.