Начало работы с REST API

API (opens new window) - это специальный веб-интерфейс, который позволяет взаимодействовать с Sales Ninja на HTTP вызовов (opens new window).

Авторизация

Для защиты от несанкционированного доступа, каждое обращение в API Sales Ninja должно содержать специальный токен.

Токен уникален на уровне проекта. Его можно посмотреть в настройках проекта:

Токен необходимо передавать в заголовке (opens new window) X-SN-TOKEN.

Если вы не передадите X-SN-TOKEN или указанный токен будет неверным, то при запросе вы получите ответ с кодом 401 Unauthorized (opens new window)

URL для обращения и версионирование

Базовый адрес для API - https://api.sales-ninja.me/outer/v1.0/

API имеет версионирование. На данный момент доступна (и соответственно - является актуальной) первая версия API.

Если работа или контракты работы с методами API будут меняться - то версия API будет увеличиваться, отражая существующие несовместимые между разными версиями изменения.

Однако старые версии API будут поддерживаться, чтобы не нарушить работу существующих приложений.