REST-API

API предоставляет возможность программно взаимодействовать со всеми сущностями приложения: контакты, карты, транзакции…

PreviousВиджет на сайт NextБиблиотека для PHP

Last updated 9 months ago

Was this helpful?

REST-API

Клиентский ключ и роли

«Клиентский API-ключ» — Работа с API строится относительно аккаунта клиента уровня приложения. Каждый клиент имеет свой id в формате uuid, он указан в настройках приложения и называется

Работа с API возможна от двух ролей:

admin — роль с максимальными привилегиями, позволяет работать с любой сущностью приложения, используется для интеграции с другим серверным приложением или «толстым клиентом» вроде 1С
user — роль с минимальными привилегиями и ограниченным набором методов, используется для работы с API от конкретного контакта (физлица), позволяет взаимодействовать только со своими данными: профилем контакта, картой, соглашениями и т.д. токен выдаётся в ответ на подтверждение доступа к мобильному телефону или email контакта путём отправки sms-кода.

Точка входа и правила построения URL

https://loyalty.b24.cloud/api/v2/ — эндпоинт для выполнения запросов

URL строится по правилу:

https://loyalty.b24.cloud/api/v2/client_key/role/... где:

client_key — «Клиентский API-ключ».
role — роль, может принимать значения admin или user
... — API метод, см. документацию по методам.

Документация по методам

https://loyalty.b24.cloud/public/docs/api/v2/#/ — описание в формате OPEN API 3.0