Autenticación
Aprende cómo autenticar tus solicitudes a la API de Qamaq usando claves API.
Claves API
La API de Qamaq usa claves API para autenticar solicitudes. Las claves API están vinculadas a tu organización y pueden tener diferentes alcances de permisos para controlar qué acciones pueden realizar.
Mantén tus claves API seguras
Nunca compartas tus claves API en repositorios públicos, código del lado del cliente u otras ubicaciones accesibles públicamente. Trátalas como contraseñas.
Creando Claves API
Para crear una clave API:
- 1Inicia sesión en tu panel de Qamaq
- 2Navega a Configuraciones > Claves API
- 3Haz clic en "Crear Nueva Clave API"
- 4Dale a tu clave un nombre descriptivo y selecciona los alcances apropiados
- 5Copia y guarda de forma segura tu clave API - no se mostrará de nuevo
Usando Claves API
Incluye tu clave API en el encabezado Authorization usando el 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()Alcances de Claves API
Las claves API pueden tener diferentes alcances que controlan a qué recursos pueden acceder:
| Scope | Description |
|---|---|
entities:read | Leer esquemas de entidades y registros |
entities:write | Crear y modificar registros de entidades |
knowledge:read | Leer carpetas y archivos de la base de conocimiento |
knowledge:write | Crear y modificar carpetas y archivos |
boards:read | Leer tableros y tickets |
boards:write | Crear y modificar tableros y tickets |
Errores de Autenticación
Si la autenticación falla, recibirás una de estas respuestas de error:
401No Autorizado
No se proporcionó clave API o el formato de la clave es inválido.
403Prohibido
La clave API es válida pero no tiene permiso para el recurso o acción solicitada.
Mejores Prácticas
- Usa variables de entorno para almacenar claves API, nunca las codifiques directamente
- Crea claves API separadas para diferentes aplicaciones o entornos
- Usa los alcances mínimos requeridos para cada clave API
- Rota las claves API periódicamente para mejor seguridad
- Monitorea el uso de claves API en tu panel
- Revoca inmediatamente cualquier clave API que pueda haber sido comprometida