API (api)

Организация REST-API на сайте.

Техническая информация о доступных методах и их работе, можно узнать на странице "документации API".

Настройки

На странице настроек, доступны следующие параметры:

кто может использовать API. Варианты настроек: отключено - апи отключено для всех, все пользователи или пользователи, у которых в личных настройках выставлено разрешение.

Несколько вариантов: через GET параметр api-token или через заголовок (headers) с названием api-token.

Настройка отвечающая за запись логов

Настройка отвечающая за запись и хранение логов callback

Методы, которые доступны для пользователей.

Создание токена в админ-панели

Для того, чтобы добавить токен из админ-панели, необходимо перейти на страницу создания токена

и заполнить все поля:

ID пользователя. 0 - это значит, что ключ создается для системы. Система имеет право работать со всеми методами выбранными в токене, независимо от настроек.

С каких IP-адресов разрешено обращение к АПИ с данным токеном. Можно указывать не только полный IP, но и подсеть, к примеру: 127.0.0 или 127.0

Методы, которые разрешены для данного токена

Создание токена на сайте, в ЛК

Если пользователю, согласно настройкам, разрешено пользоваться API, в меню пользователей появится пункт API

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

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

С каких IP-адресов разрешено обращение к АПИ с данным токеном. Можно указывать не только полный IP, но и подсеть, к примеру: 127.0.0 или 127.0

После создания, у пользователя в списке токенов появится токен. Токенов можно создать несколько. Их можно удалять или редактировать.