Создание ссылки для входа

API 0.16.0OpenAPIllms-full.txt

POST/v1/auth/login-link

Сервер партнёра вызывает POST /v1/auth/login-link с X-API-Key и X-Customer-ID. Укажите mailbox_id для входа только в этот ящик; без него откроется весь аккаунт. locale выбирает язык интерфейса.

Авторизация и области доступа · Ошибки и повторы

Запрос

curl -X POST 'https://adapt-mail.com/v1/auth/login-link' \
  -H 'X-API-Key: <mail-api-key>' \
  -H 'X-Customer-ID: <mail-account-id>' \
  -H 'Content-Type: application/json' \
  --data '{"mailbox_id":1,"locale":"en"}'

Параметры

X-Customer-IDheaderОбязательно

integer

minimum: 1

Тело запроса · application/json

object

mailbox_id

Вариант 1

integer

exclusiveMinimum: 0

Вариант 2

null

locale

string

Допустимые значения: "en" "ru" "fr" "es" "de" "zh-cn" "ko" "tr" "hi" "pt-br"

По умолчанию: "en"

Неизвестные поля не принимаются.

Ответы

201 Успешный ответ

application/json

object

login_urlОбязательно

string

expires_inОбязательно

integer

300

expires_atОбязательно

string

account_idОбязательно

integer

mailbox_idОбязательно

Вариант 1

integer

Вариант 2

null

Неизвестные поля не принимаются.

401 Ошибка запроса

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

403 Ошибка запроса

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

404 Ошибка запроса

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

422 Ошибка запроса

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

503 Ошибка запроса

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object