Skip to main content
POST
Criar integração

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Body

application/json
name
string
required

Nome da integração

Maximum string length: 191
type
enum<string>
required

Tipo da integração

Available options:
correios
product_hashes
string[]
required

Lista de hashes de produtos vinculados à integração.

Regras:

  • Pelo menos 1 produto é obrigatório.
  • Devem pertencer ao cliente autenticado.
  • Para integrações do tipo correios, todos os produtos devem ser do tipo físico.
Minimum array length: 1
options
object

Configurações específicas da integração.

Para integrações do tipo correios, os campos abaixo são obrigatórios:

  • username - Usuário de autenticação Correios
  • api_key - Chave da API Correios
  • postcard_number - Número do cartão de postagem

Response

Integração criada com sucesso

hash
string
required

Hash único da integração

name
string
required

Nome da integração

type
enum<string>
required

Tipo da integração

Available options:
correios
product_hashes
string[]
required

Lista de hashes dos produtos vinculados à integração

created_at
string<date-time>
required

Data de criação no formato ISO 8601

updated_at
string<date-time>
required

Data de atualização no formato ISO 8601

options
object

Configurações específicas da integração