Criar chave de API

Endpoint: POST /integrations/apikeys/{seller_id}/apikeys/

Autenticação: token JWT obrigatório. Chaves de API não podem criar novas chaves — apenas um usuário autenticado pode. Consulte Autenticação.

Provisiona uma nova chave de API para o vendedor. O segredo é gerado no servidor (um UUID4) e devolvido no campo key da resposta.

O valor key é o único elemento necessário para autenticar seu cliente como o vendedor nos endpoints protegidos (atualmente: os endpoints de webhooks). Ele é retornado somente nesta chamada de criação — buscas posteriores omitem o valor intencionalmente. Se você o perder, remova a chave e provisione uma nova.

Parâmetros de caminho

string (uuid)

required

Vendedor em nome do qual a chave atuará. Deve referenciar um vendedor existente; caso contrário a requisição é rejeitada com 400 e mensagem "Seller not found.".

Corpo

string

required

Rótulo legível, por exemplo "Servidor de produção".

string

required

Descrição livre. O campo não aceita valor nulo; envie ao menos uma string vazia.

boolean

default:"true"

Indica se a chave já fica utilizável de imediato. Definindo false, a chave é criada mas é rejeitada na autenticação até que seja reativada via Atualizar chave de API.

Resposta

string (uuid)

ID da chave de API. Armazene-o para poder atualizar ou remover a chave depois.

string

O token de autenticação. Envie-o como Authorization: Bearer <key> em qualquer endpoint que aceite autenticação por chave de API. Exibido somente aqui.

boolean

{
  "id": "c4f1e8a3-7d92-4b6f-9e10-2a3b4c5d6e7f",
  "name": "Servidor de produção",
  "description": "Utilizada pelo backend de checkout do vendedor",
  "key": "a7d3f1e2-9b04-4c5a-86df-1e2a3b4c5d6e",
  "active": true
}

O que a chave pode fazer

A chave autentica os endpoints de gestão de webhooks sob /integrations/webhooks/. A plataforma ainda não associa uma lista de permissões granulares à chave — trata-se de um token de longa duração com escopo no vendedor para essa área. O booleano active é o interruptor de liga/desliga.

Erros

Status	Quando
`400`	`seller_id` não existe (`"Seller not found."`) ou um campo obrigatório está ausente.
`401`	JWT ausente ou inválido.

Exemplos

curl -X POST https://api.dlpay.cloud/integrations/apikeys/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/apikeys/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Servidor de produção",
    "description": "Utilizada pelo backend de checkout do vendedor",
    "active": true
  }'

import requests

response = requests.post(
    "https://api.dlpay.cloud/integrations/apikeys/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/apikeys/",
    headers={"Authorization": f"Bearer {access_token}"},
    json={
        "name": "Servidor de produção",
        "description": "Utilizada pelo backend de checkout do vendedor",
        "active": True,
    },
)
created = response.json()
api_key_secret = created["key"]

const response = await fetch(
  "https://api.dlpay.cloud/integrations/apikeys/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/apikeys/",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${accessToken}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Servidor de produção",
      description: "Utilizada pelo backend de checkout do vendedor",
      active: true,
    }),
  },
);
const created = await response.json();
const apiKeySecret = created.key;

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Parâmetros de caminho

Corpo

Resposta

O que a chave pode fazer

Erros

Exemplos

​Parâmetros de caminho

​Corpo

​Resposta

​O que a chave pode fazer

​Erros

​Exemplos

Parâmetros de caminho

Corpo

Resposta

O que a chave pode fazer

Erros

Exemplos