Обновлено 13 декабря 2024 г.

API для разработчиков solOS v1

Вместо {{YOUR_CRM_URL}} укажите URL-адрес, по которому доступна ваша версия solOS. Почти всегда для работы с публичными методами необходимо передавать заголовки X-Crypto-Token и X-Crypto-Secret. В примерах они указаны, как {{YOUR_CRM_TOKEN}} и {{YOUR_CRM_SECRET}} соответственно, вместо реальных ключей. Ответы от сервера приходят в формате JSON.

Будьте предельно осторожны при передаче ключей третьим лицам. Ключи имеют такое же значение, как и личные пароли пользователей. Выдавайте ключи только проверенным пользователям, желательно создав для них отдельную группу и тщательно настроив права доступа.

Ключи можно получить в профиле пользователя в разделе Доступ к API.

Коды ответов API сервера

200: Успешно – Запрос был выполнен корректно.
400: Ошибка клиента – Неверный запрос, например, из-за неправильных полей или формата данных.
401: Ошибка авторизации – Проверьте ключ доступа, необходимые заголовки и права пользователя.
403: Доступ запрещён – Пользователь не имеет прав доступа к запрашиваемому ресурсу.
404: Не найдено – Запрос завершился неудачей из-за отсутствия данных на сервере.
500: Ошибка сервера – Если проблема повторяется, пожалуйста, свяжитесь с технической поддержкой f@fbybf.ceb.

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

Изучите наш репозиторий с примерами скриптов для solOS.