DOCS

Get started

/

Comece com a API Zonos

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

A API Zonos é construída em torno do REST. A API 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 Zonos, você precisará de uma chave de API. A mesma chave de API será usada para fins de teste e quando a integração estiver ativa. A chave de API é usada para autenticar as solicitações.

Periodicamente, adicionaremos campos à nossa API. Para evitar erros uma vez que você esteja integrado com 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 para o servidor em um cabeçalho que se parece com o seguinte:

serviceToken: meowmeowmeow

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

Versão 

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

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

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

Esta página foi útil?