Qamaq - AI-Powered Teammate for Every Employee

API Keys

A API do Qamaq usa API keys para autenticar requisições. API keys estão vinculadas à sua organização e podem ter diferentes escopos de permissão para controlar quais ações podem ser executadas.

Mantenha suas API keys seguras

Nunca compartilhe suas API keys em repositórios públicos, código do lado do cliente ou outros locais publicamente acessíveis. Trate-as como senhas.

Criando API Keys

Para criar uma API key:

1Faça login no seu painel do Qamaq
2Navegue até Configurações > API Keys
3Clique em "Criar Nova API Key"
4Dê um nome descritivo à sua key e selecione os escopos apropriados
5Copie e armazene sua API key com segurança - ela não será exibida novamente

Usando API Keys

Inclua sua API key no header Authorization usando o esquema Bearer:

cURL

curl -X GET "https://api.qamaq.io/api/v1/me" \
  -H "Authorization: Bearer qmq_your_api_key"

JavaScript

const response = await fetch('https://api.qamaq.io/api/v1/me', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer qmq_your_api_key'
  }
});
const data = await response.json();

Python

import requests

response = requests.get(
    'https://api.qamaq.io/api/v1/me',
    headers={'Authorization': 'Bearer qmq_your_api_key'}
)
data = response.json()

Escopos de API Key

API keys podem ter diferentes escopos que controlam quais recursos podem acessar:

Scope	Description
`entities:read`	Ler schemas e registros de entidades
`entities:write`	Criar e modificar registros de entidades
`knowledge:read`	Ler pastas e arquivos da base de conhecimento
`knowledge:write`	Criar e modificar pastas e arquivos
`boards:read`	Ler quadros e tickets
`boards:write`	Criar e modificar quadros e tickets

Erros de Autenticação

Se a autenticação falhar, você receberá uma destas respostas de erro:

401Unauthorized

Nenhuma API key foi fornecida ou o formato da key é inválido.

403Forbidden

A API key é válida mas não tem permissão para o recurso ou ação solicitada.

Melhores Práticas

Use variáveis de ambiente para armazenar API keys, nunca codifique-as diretamente
Crie API keys separadas para diferentes aplicações ou ambientes
Use os escopos mínimos necessários para cada API key
Faça rotação de API keys periodicamente para melhor segurança
Monitore o uso de API keys no seu painel
Revogue imediatamente quaisquer API keys que possam ter sido comprometidas