Bem-vindo à documentação de referência da API da Zonos.
Nota: A Zonos utiliza agora o GraphQL como API principal, com suporte completo de funcionalidades. Os endpoints REST são mantidos com suporte limitado, apenas para integrações antigas. Para novas integrações, utilize a nossa API GraphQL.
A API REST da Zonos disponibiliza URL orientados a recursos, devolve respostas codificadas em JSON, aceita corpos de pedido codificados como formulário e utiliza códigos de resposta HTTP e autenticação padrão.
Para aceder à API da Zonos, irá precisar de uma chave de API. A mesma chave de API será utilizada para testes e quando a integração estiver em produção. A chave de API serve para autenticar os pedidos.
Periodicamente, iremos adicionar campos à nossa API. Para evitar erros depois de concluir a integração com a nossa API, recomendamos que ignore os campos desconhecidos.
Para aceder à versão da API REST, envie o cabeçalho zonos-version. Consulte a documentação da API correspondente para obter as informações de cabeçalho adequadas, se aplicável e obrigatório.
Se não for especificada nenhuma versão, será utilizada por predefinição a última versão suportada.
O cabeçalho da versão atual é zonos-version: 2021-01-01.
Começar
Começar a utilizar a API da Zonos
Bem-vindo à documentação de referência da API da Zonos.A API REST da Zonos disponibiliza URL orientados a recursos, devolve respostas codificadas em JSON, aceita corpos de pedido codificados como formulário e utiliza códigos de resposta HTTP e autenticação padrão.
Para aceder à API da Zonos, irá precisar de uma chave de API. A mesma chave de API será utilizada para testes e quando a integração estiver em produção. A chave de API serve para autenticar os pedidos.
Periodicamente, iremos adicionar campos à nossa API. Para evitar erros depois de concluir a integração com a nossa API, recomendamos que ignore os campos desconhecidos.
Autenticação
A Zonos utiliza chaves de API para permitir o acesso à API. Pode registar uma nova conta Zonos e obter uma chave de API aqui.
A chave de API será incluída em todos os pedidos de API enviados ao servidor, num cabeçalho semelhante ao seguinte:
serviceToken: meowmeowmeowVersão
Para aceder à versão da API REST, envie o cabeçalho
zonos-version. Consulte a documentação da API correspondente para obter as informações de cabeçalho adequadas, se aplicável e obrigatório.Se não for especificada nenhuma versão, será utilizada por predefinição a última versão suportada.
O cabeçalho da versão atual é
zonos-version: 2021-01-01.Esta página foi útil?