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

Image Added

Agora REST API

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

Что такое API?

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

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

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

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

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

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

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

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

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

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

• и т.д.

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

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

Image Added

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

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

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

Ответ:

Image Added

Ошибки

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

Image Added

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

Image Added

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

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

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

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

Наш сервис предоставляет возможность подключения внешнего API ( REST API ), который обеспечивает возможность интеграции со строгими сервисами. Документация по API доступны по адресу вида: http://адрес_проекта.ru/api/rest/docs

 Подключение функциональности осуществляется по запросу в техническую поддержку: help@agora.ru или через личного менеджера. 

Для ознакомления можно воспользоваться тестовым проектом.

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

Качестве примера возьмем запрос на инициацию обратного звонка: callback_request

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

Image Removed

Указав все необходимые данные запроса достаточно нажать на кнопку Try it out, чтобы инициировать выполнение запроса:

Image Removed

При успешно обработанном запросе вы увидите уведомление вида: 

Image Removed

В разделе Response Body будет отображаться массив данных, который был передан на портал: 

Image Removed

Для проверки корректности выполненного запроса достаточно перейти в панели администратора в раздел Заявка на обратный звонок

Image Removed

Открыв соответствующий раздел, вы увидите информацию о выполняемом нами запросе: 

Image Removed

По аналогии с вышеописанным API методом можно выполнить любой из приведенного списка API запросов: http://адрес_проекта.ru/api/rest/docs