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

Image Added

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 Image Addedconsultas.

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: Image Added. A solicitação é esperada no formato Image Added 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 Image Added.

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/:

Image Added

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:

Image Added

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:

Image Added

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:

Image Added

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 Added
   
2. Clique no botão Tentar no lado direito da tela.
   Image Added
   
3. Um formulário para preenchimento dos campos de solicitação será aberto. Na guia Request, preencha todos os campos obrigatórios.
   Image Added
   
4. Se necessário, adicione a chave de autorização recebida anteriormente à seção Security.
   Image Added
   
5. Clique no botão Enviar.
   Image Added
   
6. Você também pode editar a solicitação e reenviá-la.
   Image Added
   
7. A resposta será exibida na guia Response.
   Image Added

Nosso serviço oferece a capacidade de conectar uma API externa (REST API), que fornece a capacidade de se integrar a serviços rigorosos. A documentação da API está disponível em: http:// Project_address.ru/api/rest/docs

A conexão da funcionalidade é realizada mediante solicitação de suporte técnico: help@agora.ru ou através de um personal manager. 

Para familiarização, você pode usar o projeto de teste.

Para facilitar o uso, descreveremos o processo de execução de uma solicitação de API, com foco em que você pode executar os outros. 

Como exemplo, vamos fazer um pedido de iniciação de retorno de chamada: callback_request

Para executar os métodos de API, clique no nome do método API e digite os parâmetros de consulta apropriados na lista de drop-down:

Image RemovedTendo especificado todos os dados de solicitação necessários, basta clicar no botão Try it out para iniciar a execução da solicitação:

Image RemovedSe a solicitação for processada com sucesso, você verá uma notificação do seguinte formulário:

Image RemovedA seção Response Body exibirá o conjunto de dados que foi carregado no portal:

Image RemovedPara verificar a correção da solicitação concluída, basta ir ao painel administrativo na seção solicitação de retorno de chamada

Image RemovedAo abrir a seção correspondente, você verá informações sobre a solicitação que estamos executando:

Image Removed

Por analogia com o método de API acima, você pode executar qualquer uma das seguintes listas de API de solicitação http://адрес_проекта.ru/api/rest/docs: