Criar um link de acesso

API 0.16.0OpenAPIllms-full.txt

POST/v1/auth/login-link

Seu servidor chama POST /v1/auth/login-link com X-API-Key e X-Customer-ID. Informe mailbox_id para abrir apenas essa caixa; omita o campo para abrir toda a conta. locale seleciona o idioma da interface.

Áreas de autorização e acesso · Erros e repetições

Solicitar

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"}'

Opções

X-Customer-IDheaderNecessariamente

integer

minimum: 1

Solicitar corpo · application/json

object

mailbox_id

Opção 1

integer

exclusiveMinimum: 0

Opção 2

null

locale

string

Valores válidos: "en" "ru" "fr" "es" "de" "zh-cn" "ko" "tr" "hi" "pt-br"

Padrão: "en"

Campos desconhecidos não são aceitos.

Respostas

201 Resposta bem-sucedida

application/json

object

login_urlNecessariamente

string

expires_inNecessariamente

integer

300

expires_atNecessariamente

string

account_idNecessariamente

integer

mailbox_idNecessariamente

Opção 1

integer

Opção 2

null

Campos desconhecidos não são aceitos.

401 Erro na solicitação

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

403 Erro na solicitação

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

404 Erro na solicitação

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

422 Erro na solicitação

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

503 Erro na solicitação

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object