Scope
svoy
Описание
Метод предназначен для компаний, которые сотрудничают с проектом Свой в Альфе и чьи продукты продают агенты проекта. Позволяет передать событие мотивации агента по продукту партнёра – чтобы агент мог отслеживать свои сделки в личном кабинете, а банк начислял за них выплаты.
Параметры запроса
Bearer {access_token}, полученный по Client Credentials Flow
application/json
application/json
Код события, согласованный при подключении с партнёром API и добавленный в справочник кодов событий
Уникальный идентификатор заказа/заявки в системе партнёра API
Уникальный идентификатор экземпляра продукта, купленного клиентом. SKU / номер страхового полиса / идентификатор или алиас банковской карты
Идентификатор партнёра проекта «Свой в Альфе», благодаря которому произошло событие
Метка в сыром виде, которой была размечена ссылка, по которой клиент оформил продукт или выполнил иное действие. Например, содержимое UTM меток. Формат меток согласовывается с каждым партнёром API отдельно
Время, когда произошло событие, в формате ISO 8601
Информация о клиенте/покупателе
Уникальный идентификатор клиента/покупателя в системе партнёра API
ФИО клиента
Контактный телефон клиента с кодом страны
Адрес проживания клиента
JSON-объект с дополнительной информацией по событию. У каждого event_id может быть свой формат заполнения
1curl --location 'https://baas.alfabank.ru/api/svoy/jp/v1/events' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "eventCode": "insurance-travel-paid",
7 "orderId": "10884",
8 "productId": "9999",
9 "agentId": "12432",
10 "tagFromLink": "alfapartners_msv_CC_12432_35564645546",
11 "createdAt": "2017-05-20T10:07:05Z",
12 "client": {
13 "id": "102342",
14 "fullName": "Иванов Иван Иванович",
15 "phone": "79001112233",
16 "address": "Коптевский бульвар, 16к2, Москва"
17 },
18 "additionalData": {}
19}'Параметры ответа
1{
2 "eventId": 10,
3 "eventCode": "insurance-travel-paid",
4 "orderId": "10884",
5 "client": {
6 "id": "102342",
7 "fullName": "Иванов Иван Иванович",
8 "phone": "79001112233",
9 "address": "Коптевский бульвар, 16к2, Москва"
10 },
11 "productId": "9999",
12 "agentId": "12432",
13 "tagFromLink": "alfapartners_msv_CC_12432_35564645546",
14 "createdAt": "2017-05-20T10:07:05Z",
15 "additionalData": {}
16}Уникальный идентификатор события в системе проекта «Свой в Альфе»
Код события, согласованный с партнёром API и добавленный в справочник кодов событий
Уникальный идентификатор заказа/заявки в системе партнёра API
Информация о клиенте/покупателе
Уникальный идентификатор клиента/покупателя в системе партнёра API
ФИО клиента
Контактный телефон клиента с кодом страны
Адрес проживания клиента
Уникальный идентификатор экземпляра продукта, купленного клиентом. SKU / номер страхового полиса / идентификатор или алиас банковской карты
Идентификатор агента проекта «Свой в Альфе», благодаря которому произошло событие
Метка в сыром виде, которой была размечена ссылка, по которой клиент оформил продукт или выполнил иное действие. Например, содержимое UTM меток. Формат меток согласовывается с каждым партнёром API отдельно
Время, когда произошло событие, в формате ISO 8601
JSON-объект с дополнительной информацией по событию, у каждого event_id может быть свой формат заполнения
1{
2 "eventId": 10,
3 "eventCode": "insurance-travel-paid",
4 "orderId": "10884",
5 "client": {
6 "id": "102342",
7 "fullName": "Иванов Иван Иванович",
8 "phone": "79001112233",
9 "address": "Коптевский бульвар, 16к2, Москва"
10 },
11 "productId": "9999",
12 "agentId": "12432",
13 "tagFromLink": "alfapartners_msv_CC_12432_35564645546",
14 "createdAt": "2017-05-20T10:07:05Z",
15 "additionalData": {}
16}Код ошибки. Принимает возможные значения:
- •
invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers."
4}Код ошибки. Принимает возможные значения:
- •
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
4}Код ошибки. Принимает возможные значения:
- •
insufficient_scope- у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; - •
access_denied- доступ к событию запрещён
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token."
4}Код ошибки. Принимает возможные значения:
- •
unknown_endpoint- эндпоинт не найден или неактивен; - •
not_found- код события не найден
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Route is not found or not active."
4}Код ошибки. Принимает возможные значения:
- •
conflict- событие с такимorderIdуже существует
Описание ошибки
1{
2 "error": "conflict",
3 "error_description": "Request could not be processed because of conflict in the request"
4}Код ошибки. Принимает возможные значения:
- •
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error."
4}