Para acessar a documentação, selecione a seção API no painel de administração ou siga o link.

Agora REST API

Você pode usar essa especificação para trabalhar com métodos de API usando Postman: Download.

O que é uma API?

API (Application Programming Interface) é uma interface que torna possível controlar qualquer software (por exemplo, um aplicativo, serviço, programa) usando comandos especiais.

Para que servem as APIs do Agora?

Oferecemos uma descrição dos métodos de API que você pode usar para executar tarefas como:

• cadastro de usuários;
• importação de mercadorias, bem como preços e saldos de mercadorias;
• recebimento e envio de pedidos, bem como atualização de seus status;
• receber informações sobre novidades e promoções;
• recebimento e criação de reclamações;
• obtenção de informações analíticas sobre produtos, pedidos, clientes;
• Receber e enviar mensagens em formulários de feedback ou chat
• etc.

Características da API Agora

Protocolo de Transferência de Dados

A API oferece suporte a protocolos HTTPS.

Formato do pedido

A API oferece suporte a CORS – solicitações entre domínios.

A API do Agora usa consultas.

Autorização

As solicitações exigem uma chave de API para autorização. Para obter a chave, você precisa enviar uma solicitação para a seguinte URL de autorização: . A solicitação é esperada no formato e contém os seguintes campos:

• email (opcional se o campo de login estiver preenchido);
• login (opcional se o campo de e-mail estiver preenchido);
• password (obrigatório)

Formato do pedido

As solicitações usam o formato .

Formato da resposta

O formato de resposta padrão é JSON.

Estrutura de Resposta

A resposta ao solicitar uma lista de objetos contém os seguintes parâmetros:

Para obter um exemplo de resposta, consulte Filtrando solicitações.

Quando um objeto é consultado em um pk específico, a resposta contém um único objeto JSON com os nomes e valores de propriedade do objeto solicitado. Exemplo de uma resposta a uma solicitação para url /news/1/:

Filtrando solicitações

A API do Agora tem a capacidade de filtrar por URL. Para filtrar os dados recebidos, você precisa passar o campo para filtragem e o valor desejado para os parâmetros de consulta da url. Um exemplo de uma consulta com filtragem de notícias.

URL: https://api-cloud.agora.ru/api/rest/v1/news/?title=Тест

Responder:

Erros

Todos os erros são representados na forma de um status legível por humanos e máquinas. O corpo da resposta contém informações mais detalhadas sobre o erro e é gerado dependendo de seu tipo. A maioria dos erros contém uma chave de "detalhe" no corpo. Exemplo:

Os erros de validação, no entanto, contêm chaves que correspondem a campos de consulta ou "non_field_errors" se o erro não estiver vinculado ao valor de um campo de consulta específico. Exemplo:

Descrição dos códigos de status utilizados:

Enviar uma solicitação de teste

Para verificar o funcionamento da API, você pode enviar uma solicitação de teste da subseção correspondente da documentação:

1. Selecione o método de API desejado na barra de navegação esquerda.
   Image RemovedImage Added
   
2. Clique no botão Tentar Try it no lado direito da tela.
   Image AddedImage Removed
   
3. Um formulário para preenchimento dos campos de solicitação será aberto. Na guia Request, preencha todos os campos obrigatórios.
   Image AddedImage Removed
   
4. Se necessário, adicione a chave de autorização recebida anteriormente à seção Security.
   
   
5. Clique no botão Enviar Send .
   Image RemovedImage Added
6. Você também pode editar a solicitação e reenviá-la.
   Image AddedImage Removed
   
7. A resposta será exibida na guia Response.
   Image RemovedImage Added