Общие правила использования API

Для доступа ко всем методам всех контроллеров используется метод запроса POST

Поля запроса передаются в виде FormData

Обязательными полями для каждого запроса являются:

  • controller (имя контроллера),
  • action (имя метода),
  • sig (ключ доступа к api).

Параметр sig является ключом для доступа к api, его можно узнать в своем личном кабинете в разделе: Настройки -> Общие.

Например, для создания виджета данная связка параметров будет выглядеть так:

controller=widget, action=create, sig=<your_api_key>

Имя контроллера и метода, передаются в snake case, несмотря на то, что в данной документации их имена приведены в camel case, служебные слова "Controller" и "Action" отбрасываются. Например, для контроллера PhonesListController и его метода AddToListAction поля controller и action в запросе будут выглядеть:

controller=phones_list, action=add_to_list, sig=<your_api_key>

Полный список приведен в разделе "Контроллеры и методы".

results matching ""

    No results matching ""