Отправка приглашения
Партнёр может инициировать отправку приглашения для регистрации в системе Инвойсбокс.
При успешном выполнении запроса на указанный адрес электронной почты будет отправлена ссылка для регистрации в системе Инвойсбокс. После успешной регистрации и оформления договора, пользователь получит код для активации для настройки своего магазина.
Для отправки приглашения, отправьте следующий запрос:
- метод:
POST - ресурс:
/v3/notification/api/invite - тело запроса - объект InviteRequest
- тело ответа - объект InviteResponse
- Возможные ошибки
Пример запроса и ответа
POST /v3/notification/api/invite
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json
{
"identifier": "shop@shop.com",
"type": "email",
"partnerId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
}
{
"data":{
"id":"d5490c3d-e2f8-4f90-aa8b-87b1cd2956af"
}
}
Ответ (по схеме):
{
"data": {
"id": "01771534-1a57-f184-dee3-ebeb91dded75"
},
"metaData": {
"totalCount": 1,
"pageSize": 1,
"page": 1
},
"extendedData": [
{
"type": "string",
"data": {}
}
]
}
InviteRequest
| Свойство | Тип | Описание | Пример значения |
|---|---|---|---|
| partnerId * | string(36) | Идентификатор партнёра (интегратора) | 01771534-1a57-f184-dee3-ebeb91dded76 |
| type * | enum | Тип приглашения | email |
| identifier * | string(100) | Значение приглашения | shop@shop.com |
InviteResponse
| Свойство | Тип | Описание | Пример значения |
|---|---|---|---|
| id * | int | Идентификатор приглашения | 123 |