Autenticación
Todas las solicitudes a la API de Vesvank requieren autenticación mediante una clave de API (API Key). Esta clave identifica de manera única a tu cuenta y determina el acceso a los recursos disponibles.
Nota: Cada clave de API está asociada directamente a una cuenta. Esto significa que tendrá acceso a todos los recursos disponibles para esa cuenta. Por lo tanto, es fundamental gestionar cuidadosamente las claves de API y sus permisos.
Tipos de claves
Section titled “Tipos de claves”Cuando generas una clave de API, se crean dos tokens:
- Publishable Key: Clave pública que se utiliza para identificar tu cuenta en el frontend.
- Secret Key: Clave privada que se utiliza para autenticar las solicitudes a la API.
¿Cómo se envía la clave de API?
Section titled “¿Cómo se envía la clave de API?”Debes incluir tu Secret Key en el encabezado Authorization
de cada solicitud HTTP, usando el esquema Bearer
:
curl -X GET \ https://<subdomain>.vesvank.com/api/endpoint \ -H "Authorization: Bearer sk_test_xxxxxxxxxxxxxxxxxxxxx"
Modos de prueba y producción
Section titled “Modos de prueba y producción”Vesvank ofrece claves de API separadas para test_mode
y live_mode
. Las claves de prueba te permiten realizar integraciones y pruebas sin afectar datos reales. Asegúrate de usar la clave adecuada según el entorno:
- Clave de prueba: Solo afecta datos de prueba, no interactúa con bancos reales. Estas claves siempre comienzan con el prefijo
sk_test_
para Secret Keys ypk_test_
para Publishable Keys. - Clave de producción: Opera sobre datos reales y transacciones en vivo. Estas claves siempre comienzan con el prefijo
sk_live_
para Secret Keys ypk_live_
para Publishable Keys.
Buenas prácticas
Section titled “Buenas prácticas”- Mantén tus claves de API seguras y nunca las compartas públicamente.
- Si crees que tu clave ha sido comprometida, revócala y genera una nueva desde el panel de control de Vesvank.
- Usa siempre HTTPS para todas las solicitudes a la API.
- Guarda tu Secret Key en un lugar seguro y nunca la expongas en el frontend.
- La Publishable Key puede ser utilizada de forma segura en el frontend.