Pular para o conteúdo principal
POST
Criar um link de conexão para um cliente

Autorizações

Authorization
string
header
obrigatório

Chave de API da conta.

Parâmetros de caminho

customerId
string<uuid>
obrigatório

Corpo

application/json
allowedOrigins
string[]
obrigatório
Required array length: 1 - 8 elements

Origem HTTPS exata, por exemplo https://app.example.com

Maximum string length: 200
successRedirectUrl
string

URL HTTPS em um dos allowedOrigins.

Maximum string length: 2000
failureRedirectUrl
string
Maximum string length: 2000
allowedConnectionTypes
enum<string>[]
Required array length: 1 - 2 elements
Opções disponíveis:
dedicated,
coexistence

Resposta

Link de conexão.

url
string<uri>

Página hospedada do Embedded Signup /connect/{token}. Uso único; expira em 1 hora.

token
string
expiresAt
integer<int64>

Milissegundos desde Unix epoch.

customerId
string | null
allowedConnectionTypes
enum<string>[]
Opções disponíveis:
dedicated,
coexistence
successRedirectUrl
string | null
failureRedirectUrl
string | null