QamaqQamaq

Documentação da API Qamaq

Construa integrações poderosas com a API do Qamaq. Acesse entidades, base de conhecimento, fluxos de trabalho e muito mais.

Início Rápido

1

Obtenha sua API Key

Navegue até Configurações > API Keys no seu painel do Qamaq para criar uma nova API key. Certifique-se de copiá-la imediatamente, pois ela não será exibida novamente.

2

Faça sua primeira requisição

Use sua API key no header Authorization com o esquema Bearer:

Exemplo de Requisiçãobash
curl -X GET "https://api.qamaq.io/api/v1/entities" \
  -H "Authorization: Bearer qmq_your_api_key"
3

Explore a API

Navegue pela nossa referência de API abaixo para descobrir todos os endpoints e funcionalidades disponíveis.

URL Base

Todas as requisições de API devem ser feitas para:

https://api.qamaq.io/api/v1

Versionamento da API

A versão da API está incluída no caminho da URL. A versão estável atual é v1.

Anunciaremos quaisquer mudanças incompatíveis com antecedência e manteremos compatibilidade retroativa sempre que possível.

Limites de Taxa

A API implementa limites de taxa para garantir uso justo. Limites atuais:

1000

requisições/minuto

10,000

requisições/hora

100,000

requisições/dia

Nota: Headers de limite de taxa são incluídos em todas as respostas. Se você exceder o limite, receberá uma resposta 429 Too Many Requests. Entre em contato conosco se precisar de limites mais altos.

Tratamento de Erros

A API usa códigos de status HTTP padrão para indicar sucesso ou falha das requisições:

200OKRequisição bem-sucedida
201CreatedRecurso criado com sucesso
400Bad RequestParâmetros de requisição inválidos
401UnauthorizedAPI key ausente ou inválida
403ForbiddenAPI key sem permissões necessárias
404Not FoundRecurso não encontrado
422Validation ErrorFalha na validação da requisição
429Too Many RequestsLimite de taxa excedido
500Server ErrorErro interno do servidor

Precisa de Ajuda?

Nossa equipe está aqui para ajudar você a integrar com a API do Qamaq.