Autenticación de Sandbox

Para acceder al entorno de pruebas y hacer llamadas a la API, necesitarás autenticarte usando tus credenciales. Aquí te explicamos cómo empezar:

Flujo de Autenticación

Credenciales Requeridas

Antes de hacer cualquier llamada a la API, necesitarás las siguientes credenciales:

• Api Key
• Secret

Obtener un Token de Autenticación

Para obtener un token de autenticación, haz una solicitud POST al endpoint de autenticación:

curl -X POST 'https://api-sandbox.koywe.com/api/v1/auth/sign-in' \
-H 'Content-Type: application/json' \
-d '{
  "apiKey": "your_apiKey",
  "secret": "your_secret"
}'

Parámetros de la Solicitud

Ejemplo de Respuesta

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
}

Usar el Token

Una vez que hayas recibido el token, inclúyelo en el encabezado de autorización de todas las solicitudes de API posteriores:

curl -X POST 'https://api-sandbox.koywe.com/api/v1/organizations/YOUR_ORG_ID/merchants/YOUR_MERCHANT_ID/orders' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here' \
-d '{
  // Your request payload
}'

Expiración del Token

El token de autenticación expira después de un cierto período (generalmente 1 hora). Cuando el token expira, necesitarás hacer una nueva solicitud de autenticación para obtener un token recién generado.

Respuestas de Error

Si la autenticación falla, recibirás una respuesta de error:

{
  "error": "Invalid credentials",
  "message": "The provided username or password is incorrect"
}

Escenarios de error comunes:

• Clave de API o secreto inválidos
• Campos requeridos faltantes
• Solicitud mal formada

Mejores Prácticas

1. Almacenamiento Seguro: Nunca almacenes credenciales en texto plano o commitétalas al control de versiones
2. Manejo de Tokens: Implementa un mecanismo de almacenamiento y actualización de tokens apropiado
3. Manejo de Errores: Maneja los errores de autenticación con gracia
4. Variables de Entorno: Usa variables de entorno para información sensible

¿Necesitas Ayuda?

Si encuentras algún problema con la autenticación o necesitas ayuda con tus credenciales, por favor contacta a nuestro equipo de soporte.