DOCS

Começar

Começar com a API da Zonos

Bem-vindo à documentação de referência da API da Zonos.

Nota: A Zonos agora usa GraphQL como a API principal, com suporte completo a recursos. Os endpoints REST são mantidos com suporte limitado apenas para integrações legadas. Para novas integrações, use nossa API GraphQL.

A REST API da Zonos oferece URLs orientadas a recursos, retorna respostas codificadas em JSON, aceita corpos de solicitação codificados em formulário e usa códigos de resposta HTTP padrão e autenticação.

Para acessar a API da Zonos, você precisará de uma chave de API. A mesma chave de API será usada para testes e quando a integração estiver em produção. A chave de API é usada para autenticar as solicitações.

Periodicamente, adicionaremos campos à nossa API. Para evitar erros depois que você estiver integrado à nossa API, recomendamos ignorar campos desconhecidos.

Autenticação 

A Zonos usa chaves de API para permitir o acesso à API. Você pode se registrar para uma nova conta Zonos e chave de API aqui.

A chave de API será incluída em todas as solicitações de API ao servidor em um cabeçalho semelhante ao seguinte:

serviceToken: meowmeowmeow

Nota: Certifique-se de substituir meowmeowmeow pela sua chave de API.

Versão 

Para acessar a versão da REST API, envie o cabeçalho zonos-version. Consulte a documentação da API correspondente para as informações de cabeçalho adequadas, se aplicável e necessário.

Se nenhuma versão for especificada, o padrão será a última versão suportada.

O cabeçalho de versão atual é zonos-version: 2021-01-01.

Esta página foi útil?