Claves API

Las claves API te permiten autenticar las solicitudes de tu aplicación al API de Aloha Pay. Cada clave es única y debe mantenerse segura.

Crear una clave API

Sigue estos pasos para generar una nueva clave API:

Paso 1: Acceder a la sección de Claves API

Navega al menú lateral y selecciona la opción Claves API dentro de la sección Administrativo.

Paso 2: Iniciar la creación

En la página de Claves API, haz clic en el botón + Nueva Clave API ubicado en la esquina superior derecha.

Paso 3: Completar la información

En el diálogo que aparece, ingresa un nombre descriptivo para identificar tu clave API. Este nombre te ayudará a distinguir entre múltiples claves si las necesitas.

Recomendación

Usa nombres descriptivos como “Integración ERP”, “App Móvil Producción” o “Sistema POS” para identificar fácilmente el propósito de cada clave.

Paso 4: Copiar y guardar tu clave

Una vez creada la clave, se mostrará el Secret Key completo.

Importante

Este secret key solo se mostrará una vez. Cópialo y guárdalo en un lugar seguro inmediatamente. Si lo pierdes, deberás crear una nueva clave API.

Usar tu clave API

Una vez que tengas tu clave API, inclúyela en el header X-API-KEY de todas tus solicitudes:

curl -X GET "https://api.alohapay.co/api/external/v1/endpoint" \
  -H "X-API-KEY: tu_secret_key_aqui"

Ejemplo en diferentes lenguajes

cURL

curl -X GET "https://api.alohapay.co/api/external/v1/payment-links" \
  -H "X-API-KEY: pay_BLl89iao_live_0FGv6g3aoFhJCsF5nMPwS7..."

JavaScript

const response = await fetch('https://api.alohapay.co/api/external/v1/payment-links', {
  headers: {
    'X-API-KEY': 'pay_BLl89iao_live_0FGv6g3aoFhJCsF5nMPwS7...'
  }
});
const data = await response.json();

Python

import requests

headers = {
    'X-API-KEY': 'pay_BLl89iao_live_0FGv6g3aoFhJCsF5nMPwS7...'
}

response = requests.get(
    'https://api.alohapay.co/api/external/v1/payment-links',
    headers=headers
)
data = response.json()

PHP

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.alohapay.co/api/external/v1/payment-links',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-API-KEY: pay_BLl89iao_live_0FGv6g3aoFhJCsF5nMPwS7...'
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

Administrar tus claves

Desde la página de Claves API puedes:

• Ver todas tus claves activas
• Identificar cada clave por su nombre y prefijo
• Monitorear la fecha de creación y último uso
• Revocar claves que ya no necesites

Buenas prácticas de seguridad

• Nunca compartas tu secret key públicamente
• No incluyas claves API en código del lado del cliente (frontend)
• Usa variables de entorno para almacenar tus claves en servidores
• Rota tus claves periódicamente, especialmente si sospechas que fueron comprometidas
• Crea claves separadas para diferentes aplicaciones o entornos (desarrollo, producción)