For AI agents: the complete documentation index is available at https://docs.clickmax.io/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/reference/api/index.md.
  • Português
  • API da Clickmax

    Use a API da Clickmax em https://mcp.clickmax.io/api/v0/. Todas as requisições exigem autenticação Bearer.

    Referência interativaExplore a API por endpointConsulte parâmetros, exemplos de requisição e schemas de resposta em uma única tela.Abrir referência
    A v0 ainda é instável

    O 0 em /api/v0/ indica que esta versão ainda pode mudar. Endpoints, parâmetros e respostas podem ser alterados sem aviso prévio. Consulte sempre o schema publicado antes de atualizar sua integração.

    Autenticação

    Proprietários e administradores criam e revogam chaves em Configurações > Conexões > API. Cada workspace pode manter até 5 chaves.

    A chave é exibida somente após a criação e não pode ser consultada novamente. Para substituir uma chave ou alterar seus endereços IP, revogue a anterior e crie outra.

    O prefixo identifica o ambiente: cxp_ para produção, cxs_ para staging e cxd_ para desenvolvimento.

    Uma chave sem endereços IP permitidos funciona a partir de qualquer IP. Quando a lista é preenchida, a API aceita somente os endereços IPv4 ou IPv6 exatos informados.

    Envie a chave em todas as requisições:

    Authorization: Bearer <chave-da-api>

    As chaves da API não autenticam conexões MCP. O MCP continua usando OAuth.

    Limite de requisições

    A API pública aceita até 100 requisições a cada 10 segundos por workspace. Todas as chaves do workspace compartilham esse limite.

    Quando o limite é ultrapassado, a API retorna 429 rate limit exceeded. Aguarde alguns segundos antes de tentar novamente e reduza requisições simultâneas se o erro continuar.

    Outros recursos

    RecursoQuando usar
    Schema OpenAPI YAMLConsultar o contrato atual, gerar clientes ou fornecer o schema diretamente a um agente de IA.
    MCP da ClickmaxConectar clientes de IA compatíveis com MCP e OAuth.