Общие сведения

API (Application Programming Interface) moab-apis.ru – набор инструкций для взаимодействия с moab-apis.ru программно, используя скрипты на различных языках программирования. API moab-apis.ru подробно документирован с помощью популярной системы автодокументирования кода https://scalar.com/. Это позволяет на основе имеющейся документации понять, как устроен интерфейс API, а также, не выходя из браузера, протестировать взаимодействие с конечными точками интерфейса и получить исходный код для этого на популярных языках программирования. 

Интерфейс Scalar API moab-apis.ru доступен по этому адресу. 

Руководство по Scalar доступно здесь, мы не будем повторяться. Но опишем особенности взаимодействия с API moab-apis.ru для понимания того, как им пользоваться даже при наличии готового клиента и понимания работы со Scalar.

Всё взаимодействие с API происходит в формате JSON, поэтому обязателен заголовок Content-Type: application/json (кроме тех случаев, когда в документации явно указан другой заголовок). Кодировка всех запросов и ответов – UTF-8.

Все методы API должны вызываться со специальным заголовком X-Api-Key, который должен быть заполнен уникальным ключом API, характерным только для вашего аккаунта. Узнать его вы можете в службе поддержки moab-apis.ru. Этот заголовок является обязательным во всех запросах. Регистр символов API-ключа не имеет значения.

Рекомендуется выполнять запросы в многопоточном режиме для ускорения. Поскольку API находится в состоянии beta и активно развивается - рекомендуется также использовать таймаут запросов 300 секунд и бесконечные попытки получить ответ в случае исчерпания таймаута.

API moab-apis.ru подразделяется на несколько разделов:

• Wordstat – методы работы с Yandex Wordstat.

• YandexSerp – методы работы с выдачей Yandex [пока не описано в этом руководстве].

• Region – методы работы со справочником регионов.

• GoogleSerp – методы работы с выдачей Google [пока не описано в этом руководстве].

• Finance – методы работы с финансами.

• Models – описание моделей, используемых в API [пока не описано в этом руководстве].

В данном руководстве описаны минимально необходимые действия для получения данных с помощью API moab-apis.ru. Если вам необходимо выполнить какие-то дополнительные действия или получить дополнительную информацию из тех или иных методов API – пожалуйста, обратитесь в техподдержку moab-apis.ru, мы будем рады вам помочь! API находится в состоянии beta и активно разрабатывается, вы можете повлиять на наличие и/или поведение тех или иных методов API.