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 organización y determina el acceso a los recursos disponibles.
Nota: Cada clave de API está asociada directamente a un usuario específico. Todos los permisos y restricciones que tenga ese usuario en la plataforma serán exactamente los mismos que tendrá la API Key generada para él. Por lo tanto, es fundamental gestionar cuidadosamente los permisos de los usuarios que generan claves de API.
¿Cómo se envía la clave de API?
Section titled “¿Cómo se envía la clave de API?”Debes incluir tu clave de API en el encabezado Authorization
de cada solicitud HTTP, usando el esquema Bearer
:
curl -X GET \ https://<subdomain>.vesvank.com/api/endpoint \ -H "Authorization: Bearer pk_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
pk_test_
. - Clave de producción: Opera sobre datos reales y transacciones en vivo. Estas claves siempre comienzan con el prefijo
pk_live_
.
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.