Ver .md

integrations.catalog

Catálogo de conectores. Conectores disponíveis (Hotmart, Kiwify, webhooks, Zapier, Make, n8n) com categoria, direção, tipo de segredo e passos de configuração.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/integrations.catalog (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: automations:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: integrations_catalog
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId integrations.catalog)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/integrations.catalog \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs integrations.catalog --json '{}'

MCP: ferramenta integrations_catalog com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "category": {
            "type": "string",
            "enum": [
              "vendas",
              "automacao",
              "webhook"
            ]
          },
          "direction": {
            "type": "string",
            "enum": [
              "in",
              "out"
            ]
          },
          "secret": {
            "type": "string",
            "enum": [
              "required",
              "generated",
              "none"
            ]
          },
          "setup": {
            "type": "object",
            "properties": {
              "steps": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "docsUrl": {
                "type": "string"
              }
            },
            "required": [
              "steps"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "key",
          "label",
          "category",
          "direction",
          "secret",
          "setup"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).