Skip to main content
A referência descreve cada rota com parâmetros, respostas e um playground para testar com a sua chave. Esta página cobre o que vale para todas elas.

​
URL base

O endereço da sua instância, não um domínio compartilhado da plataforma.
O playground desta referência tem um campo para trocar esse endereço pelo seu. Detalhes em a sua instância.

​
Autenticação

As rotas de consulta usam chave de API no cabeçalho; a entrada de contatos usa token no caminho da URL. A diferença e o motivo dela estão em autenticação.

​
Formatos

​
JSON
Sempre JSON, em UTF-8. Acentos e cedilha são esperados e não precisam de escape.
​
JSON nas consultas
As rotas de consulta aceitam apenas JSON. A entrada de contatos aceita também formulário codificado e multipart.
​
CORS só na entrada
A entrada de contatos aceita requisição de qualquer origem, o que permite chamá-la do navegador. As rotas de consulta não respondem a preflight, de propósito.

​
Cabeçalhos de limite

As rotas de consulta devolvem o estado do teto da chave quando ele existe.

​
Sem SDK

Não há biblioteca cliente, e não faz falta: a superfície é uma requisição HTTP com um corpo simples. Os exemplos cobrem curl, JavaScript, PHP e Python, e o playground gera o código na linguagem que você escolher.

​
Estabilidade

O que está nesta referência tem compromisso de estabilidade. O resto da plataforma responde a rotas autenticadas por sessão, feitas para o produto e não para integração de terceiros: elas podem mudar sem aviso, então não construa em cima delas.