Majento
Тарифы      Новости      Контакты                        Войти
Зарегистрироваться

. : Структура и функции API : .

 

Статистика
Компаний
Проектов
2267
Задач
2955
Пользователей
471







Bookmark and Share


MegaIndex


Руководство по использованию REST API

 

Описание работы

Система «Majento» предоставляет возможность сторонним разработчикам при помощи программных средств получать необходимые данные используя API, постороенного по REST принципам.

Преимуществом REST API является то, что его можно использовать практически из любого языка программирования, так как взаимодействие происходит по протоколу HTTP.

Использование

Все вызовы методов API – это GET или POST HTTP-запросы к URL http://www.majento.ru/api/ с некоторым набором параметров. Вы выбираете в документации нужный метод, например, text.relevancy, формируете запрос согласно документации метода, и осуществляете этот запрос. В ответ на запрос вы получаете его результат, который также описан в документации каждой функции.

  • Для правильного распознавания ваших запросов к API их содержимое должно быть в кодировке UTF-8.
  • Все ответы API отдает в формате JSON в кодировке UTF-8.

Авторизация

Все запросы к API должны содержать авторизационный токен в HTTP заголовке Authorization или передаваться как часть запроса в параметре api_key.

Авторизационный токен можно получить самостоятельно в личном кабинете.

Обработка ошибок

По умолчанию сервис всегда отдает HTTP статус 200.

Если необходимо получать HTTP код, соответствующий ошибке, в параметрах запроса необходимо передать параметр:

suppress_response_code = false

Если запрос к API выполнен с ошибкой, ответ содержит поле code с кодом и описанием ошибки в поле error (коды ошибок).