...
| Sv translation | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
To go to the documentation, select the API section in the admin panel or follow the link.
Agora REST APIYou can use this specification to work with API methods using Postman: download. What is an API?API (application programming interface) is an interface that makes it possible to control any software (for example, an application, service, program) using special commands. What is the Agora API used for?We offer a description of the API methods that you can use to perform tasks such as:
Agora API FeaturesData transfer protocolThe API supports HTTPS protocols. Request FormatThe API supports CORS - cross-domain requests. The Agora API uses AuthorizationRequests require an API key for authorization. To get the key, you need to send a request to the following URL for authorization:
Request FormatRequests use the format Response FormatThe default response format is JSON. Response structureThe response when requesting a list of objects contains the following parameters:
For an example response, see the "Request Filtering" section. When requesting an object for a specific pk, the response contains one JSON object with the names and values of the properties of the requested object. An example of a response to a request for url /news/1/:
Request filteringThe Agora API has the ability to filter by URL. To filter the received data, you need to pass the filtering field and the desired value to the url query parameters. An example of a news filtering query. URL: https://api-cloud.agora.ru/api/rest/v1/news/?title=Тест Answer:
ErrorsAll errors are presented as human- and machine-readable status. The response body contains more detailed information about the error and is formed depending on its type. Most errors contain the "detail" key in the body. Example:
Validation errors, however, contain keys that correspond to request fields, or "non_field_errors" if the error is not related to the value of a specific request field. Example:
Description of the status codes used:
Sending a test requestTo check the operation of the API, you can send a test request from the corresponding subsection of the documentation:
|
| Sv translation | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Para acessar a documentação, selecione a seção API no painel de administração ou siga o link.
Agora REST APIVocê 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:
Características da API AgoraProtocolo de Transferência de DadosA API oferece suporte a protocolos HTTPS. Formato do pedidoA API oferece suporte a CORS – solicitações entre domínios. A API do Agora usa AutorizaçãoAs 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:
Formato do pedidoAs solicitações usam o formato Formato da respostaO formato de resposta padrão é JSON. Estrutura de RespostaA 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çõesA 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:
ErrosTodos 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 testePara verificar o funcionamento da API, você pode enviar uma solicitação de teste da subseção correspondente da documentação:
|
