Подробнее про работу с API рассказано на этой странице, а также в видео:

Чтобы перейти к документации, выберите раздел API в административной панели или перейдите по ссылке. 

Agora REST API

Вы можете использовать эту спецификацию для работы с API-методами с помощью Postman: загрузить.

Что такое API?

API (от англ. application programming interface — интерфейс программирования приложений) — это интерфейс, который дает возможность с помощью специальных команд управлять каким-либо программным обеспечением (например, приложением, сервисом, программой).

Для чего используют API Agora?

Мы предлагаем описание тех методов API, которыми вы сможете оперировать для выполнения таких задач, как:

• регистрация пользователя;

• импорт товаров, а также цен и остатков по товарам;

• получение и отправка заказов, а также обновление их статусов;

• получение информации о новостях и акциях;

• получение и создание рекламаций;

• получение аналитической информации о товарах, заказах, покупателях;

• получение и отправка сообщений в формах обратной связи или чате

• и т.д.

Особенности API Agora

Протокол передачи данных

API поддерживает HTTPS протоколы.

Формат запросов

API поддерживает CORS — кросс-доменные запросы.

В API Agora используются запросы.

Авторизация

Запросы требуют API-ключ для авторизации. Чтобы получить ключ, нужно отправить запрос следующий URL для авторизации: . Запрос ожидается в формате и содержит следующие поля:

• email (не является обязательным, если заполнено поле login);
• login (не является обязательным, если заполнено поле email);
• password (обязательное поле)

Формат запроса

В запросах используется формат .

Формат ответа

Форматом ответа по умолчанию является JSON.

Структура ответа

Ответ при запросе списка объектов содержит параметры:

Пример ответа см. в разделе "фильтрация запросов".

При запросе объекта по определенному pk ответ содержит один JSON объект с названиями и значениями свойств запрошенного объекта. Пример ответа при запросе на url /news/1/:

Фильтрация запросов

В API Agora есть возможность фильтрации по URL. Чтобы отфильтровать получаемые данные, нужно в query-параметры url передать поле для фильтрации и нужное значение. Пример запроса с фильтрацией новостей.

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

Ответ:

Ошибки

Все ошибки представляются в виде человеко- и машиночитаемого статуса. Тело ответа содержит более детальную информацию об ошибке и формируется в зависимости от её типа. Большая часть ошибок содержит в теле ключ "detail". Пример:

Ошибки валидации, однако, содержат ключи, которые соответствуют полям запроса, либо "non_field_errors"в том случае, если ошибка не завязана на значении какого-то конкретного поля запроса. Пример:

Описание используемых статус кодов:

Отправка тестового запроса

Для проверки работы API можно отправить тестовый запрос из соответствующего подраздела документации:

1. Выберите нужный вам метод API в панели навигации слева.
   
2. Нажмите на кнопку Попробовать в правой части экрана.
   
   
3. Откроется форма заполнения полей запроса. Во вкладке Request заполните все необходимые поля.
   
   
4. При необходимости добавьте в раздел Security полученный ранее ключ авторизации.
   
   
5. Нажмите на кнопку Отправить.
   
   
6. Также можно отредактировать запрос и отправить его заново.
   
   
7. Полученный ответ отобразится во вкладке Response.
   

Our service provides the ability to connect to an external API (REST API), which provides the ability to integrate with strict services. API documentation is available at the following address: https://compras1.agorab2b.com/api/rest/docs
For review, you can use the test project.
For ease of use, we will describe the process of executing one API request, focusing on which you can execute the rest.
Take a callback request as an example: callback_request
To execute API methods, click on the name of the API method and enter the corresponding request parameters in the drop-down list:

Having specified all the necessary data of the request, it is enough to click on the Try it out button to initiate the execution of the request:

If the request is successfully processed, you will see a notification of the form:

The Response Body section will display the array of data that was passed to the portal:

To check the correctness of the completed request, just go to the administrator panel in the Request for a call back section

Having opened the corresponding section, you will see information about the request we are executing:

By analogy with the above API method, you can execute any of the above list of API requests: http://project_address.ru/api/rest/docs
If you encounter difficulties/errors while using the API, you should write to the technical support at help@agora.ru and you will definitely be helped.

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:

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

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

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

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

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

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:

Se houver dificuldades/erros ao usar a API, você precisa escrever para o suporte técnico no endereço: help@agora.ru e eles definitivamente irão ajudá-lo.