Документация по API
Документация Affise API позволяет работать с панелями администратора и партнера через API. В документации приведены все необходимые данные для выполнения корректных запросов и получения данных обратно.
Есть методы для пользователей панели администратора, для пользователей партнерской панели (ваших партнеров), а также общие методы.
Методы сгруппированы в зависимости от целей, которые вы хотите достичь: просмотр статистики, управление предложениями, работа с пользователями и т. д.
Главные менеджеры могут использовать методы, помеченные как методы администратора.
В методе вы можете увидеть:
где:
1: Метод API и путь, который нужно добавить в запрос API.
2: Список параметров, доступных для метода.
3: Тип данных для параметра.
4: Если необходимо, доступные и стандартные данные или форматы, которые следует использовать.
5: В описании вы можете найти дополнительную информацию о параметре: за что он отвечает, является ли он обязательным или нет и т. д.
В правой панели вы видите ответ:
где:
1: cURL-запрос, который вы можете скопировать, скорректировать и использовать в API-инструментах, таких как Postman или Insomnia.
2: пример ответа для конкретного метода. Здесь вы можете увидеть изображенные данные.
Вы можете использовать специальный документ с кодами состояния. Это поможет вам понять глобальные ошибки в ответах API.
По всем возникающим вопросам обращайтесь в службу поддержки клиентов Affise по электронной почте: [email protected].