A API REST dá acesso programático aos dados da sua empresa. Ela é para desenvolvedores que criam uma integração; você não precisa dela no uso diário.
- Referência da API: a referência completa é pública em /docs/api no endereço do seu espaço de trabalho, com o documento OpenAPI em /docs/api/openapi.yaml e /docs/api/openapi.json. API e webhooks nas Configurações traz um link para ela.
- URL base: exibida no topo de API e webhooks. Ela termina em /api/v1.
- Autenticação: envie o cabeçalho Authorization: Bearer seguido do seu token, e Accept: application/json.
- Respostas: somente JSON. Registros individuais vêm dentro de data; listas acrescentam meta e links para paginação por cursor (parâmetros limit e cursor, até 100 por página).
- Novas tentativas seguras: envie um cabeçalho Idempotency-Key nas requisições POST. Repetir a mesma requisição com a mesma chave retorna a resposta armazenada em vez de criar um segundo registro. As chaves são mantidas por 24 horas.
- Limite de requisições: 120 requisições por minuto por token. Os cabeçalhos X-RateLimit-Limit e X-RateLimit-Remaining mostram onde você está; acima do limite você recebe 429 com um cabeçalho Retry-After.
O que uma requisição pode fazer
Uma chamada só tem sucesso quando o token tem a permissão (por exemplo invoices:write) e o usuário do token tem a permissão correspondente no aplicativo. Valem as mesmas regras de negócio da tela, então uma fatura emitida também não pode ser editada pela API.
Guias relacionados
Pergunte sobre o produto
Pergunte o que o software pode fazer, como uma tarefa funciona ou quais países e idiomas ele suporta. As respostas vêm destes guias.
Pensando…
O assistente de IA não está disponível no momento. Pesquise nos guias ou fale com a nossa equipe. Falar com o suporte
A IA pode cometer erros. Confira os guias indicados.
Ainda precisa de ajuda?
Nossa equipe de suporte lê todas as mensagens e responde em linguagem simples.
Falar com o suporte