Guía de autenticación de la API

Guía de autenticación de la API

Aprende a autenticarte de forma segura con la API de atoship mediante claves de API.

Descripción general

Método de autenticación: atoship utiliza autenticación por clave de API en todas las solicitudes. Cada solicitud debe incluir tu clave de API en el encabezado.

Cómo obtener tu clave de API

Paso a paso:

1. Inicia sesión en atoship
2. Ve a Configuración → API
3. Haz clic en «Generar clave de API»
4. Cópiala y guárdala en un lugar seguro
5. La clave se muestra una sola vez

Tipos de clave de API

Niveles de clave:

Encabezado de autenticación

Encabezado obligatorio:

Authorization: Bearer YOUR_API_KEY

Ejemplo de solicitud:

curl -X GET https://api.atoship.com/v1/rates \
  -H "Authorization: Bearer sk_live_abc123..." \
  -H "Content-Type: application/json"

Formato de la clave de API

Estructura de la clave:

sk_live_xxxxxxxxxxxxxxxxxxxx (clave Live)
sk_test_xxxxxxxxxxxxxxxxxxxx (clave Test)

Ejemplos de código

JavaScript:

const response = await fetch('https://api.atoship.com/v1/rates', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_live_abc123...',
    'Content-Type': 'application/json'
  }
});

Python:

import requests

headers = {
    'Authorization': 'Bearer sk_live_abc123...',
    'Content-Type': 'application/json'
}
response = requests.get(
    'https://api.atoship.com/v1/rates',
    headers=headers
)

PHP:

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.atoship.com/v1/rates');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_abc123...',
    'Content-Type: application/json'
]);
$response = curl_exec($ch);

Buenas prácticas de seguridad

Protege tus claves:

1. Nunca las expongas en el código del cliente
2. Usa variables de entorno
3. Rota las claves periódicamente
4. Usa claves Test para el desarrollo
5. Monitorea el uso de la API

Variables de entorno

Almacenamiento seguro:

# archivo .env (¡nunca lo subas al repositorio!)
ATOSHIP_API_KEY=sk_live_abc123...

Acceso desde el código:

const apiKey = process.env.ATOSHIP_API_KEY;

Rotación de claves

Cuándo rotar:

• Sospecha de que la clave se vio comprometida
• Salida de un empleado
• Política de seguridad periódica
• Después de una auditoría de seguridad

Cómo rotar:

1. Genera una clave nueva
2. Actualiza tus aplicaciones
3. Prueba con la nueva clave
4. Revoca la clave anterior

Límite de velocidad

Límites predeterminados:

Respuestas de error

Errores de autenticación:

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key provided",
    "status": 401
  }
}

Errores comunes:

Varias claves de API

Casos de uso:

• Distintos entornos
• Distintos servicios
• Miembros del equipo
• Integradores externos

Permisos de las claves

Control de alcance:

• Acceso completo (predeterminado)
• Solo lectura
• Endpoints específicos
• Alcances personalizados

Restricciones de IP

Seguridad opcional:

• Lista blanca de IP
• Bloqueo de orígenes desconocidos
• Auditoría de registros de acceso

Monitoreo del uso

Da seguimiento a la actividad:

• Número de llamadas a la API
• Uso por endpoint
• Tasas de error
• Tiempos de respuesta

Revocación de claves

Cuando sea necesario:

1. Configuración → API
2. Localiza la clave
3. Haz clic en «Revocar»
4. Confirma la acción

Solución de problemas

Problemas de autenticación:

1. Verifica el formato de la clave
2. Revisa la ortografía del encabezado
3. Asegúrate de incluir el prefijo Bearer
4. Comprueba que la clave esté activa
5. Revisa los límites de velocidad

Modo de prueba

Configuración para desarrollo:

• Usa una clave de API Test
• Sin cargos reales
• Respuestas simuladas
• Puedes experimentar con seguridad