Запросы к API

Материал из RiXiS Wiki.
Перейти к: навигация, поиск

Синтаксис запроса

Чтобы обратиться к методу RiXiS API, Вам необходимо выполнить POST или GET запрос такого вида:

https://api.rixis.ru/API_SECTION/METHOD_NAME?PARAMETERS&v=V&access_token=ACCESS_TOKEN

Он состоит из нескольких частей:

  • API_SECTION (обязательно) — секция метода API, к которому относится ваш метод. (у каждого метода в описании указана его секция)
  • METHOD_NAME (обязательно) — название метода API, к которому Вы хотите обратиться. Полный список методов доступен на этой странице.
  • PARAMETERS (опционально) — входные параметры соответствующего метода API, последовательность пар name=value, разделенных амперсандом. Список параметров указан на странице с описанием метода.
  • V (обязательно) — используемая версия API. Использование этого параметра применяет некоторые изменения в формате ответа различных методов. На текущий момент актуальная версия API — 1.0. Этот параметр следует передавать со всеми запросами.
  • ACCESS_TOKEN (опционально) — ключ доступа. Подробнее о получении токена Вы можете узнать в этом руководстве.

Параметры могут передаваться как методом GET, так и POST. Если вы будете передавать большие данные (больше 2 килобайт), следует использовать POST.

Общие параметры

Каждый метод API имеет собственный набор входных параметров. Помимо этого, существуют общие параметры, которые могут быть использованы во всех методах: ---

Ограничения и рекомендации

Максимальное число обращений к методам 8 запросов в секунду.

Если Вы превысите частотное ограничение, сервер вернет ошибку с кодом 1009: "Too many requests per second.".

Примеры

Скоро будут

API