API Keys

Resumen

Autenticamos sus solicitudes de API utilizando la clave API - una combinación única de símbolos asociada con su cuenta. Si una solicitud no incluye una clave válida, Payment Gateway devuelve un error de solicitud inválida. Si una solicitud incluye una clave eliminada o expirada, Payment Gateway devuelve un error de autenticación.

La clave API se pasa en el encabezado X-Api-Key de una solicitud de API:

curl -X GET "https://dev.bpcbt.com/api2/sessions/test_aksdhauedqiuwehdiqwbdq" \
-H "X-Api-Key: 6HUXQFbeomV1zf5i8cgm5W8KfncENVEa5uh8RngB" \
-H "X-Version: 2023-10-31" \

Puede generar tantas claves API como sea necesario. Por ejemplo, su empresa puede requerir rotación anual de claves. Para cambiar la clave API de forma segura, recomendamos que utilice el siguiente enfoque:

1. Cuando vaya a cambiar su clave API, primero genere la nueva clave API.
2. Soporte dos claves API: 1) la antigua, 2) la nueva que acaba de generar.
3. Use la nueva clave API en las solicitudes de API para asegurarse de que estén correctamente autenticadas.
4. Elimine la clave API antigua.

Puede usar Merchant Portal para generar o eliminar claves API. Vea los detalles a continuación.

Generando una clave API

Para generar una clave API:

1. Inicie sesión en Merchant Portal
2. Vaya a la sección API Keys.

3. Haga clic en Generate API Key.

   

4. En la ventana abierta, ingrese el nombre de la clave y haga clic en Generate.

   

5. La clave API generada se muestra en la página API Keys. Puede copiar esta clave solo dentro de varios minutos (el tiempo exacto restante se muestra debajo del valor de la clave API). Después de este período de tiempo, la clave quedará enmascarada para siempre: solo se mostrarán los primeros y últimos 3 símbolos.

   

Eliminando una clave API

Para eliminar una clave API:

1. Inicie sesión en Merchant Portal
2. Vaya a la sección API Keys.

3. Haga clic en el botón de eliminación cerca de la clave API que desea eliminar.

   

4. Se abre la ventana de confirmación. Para confirmar la eliminación, ingrese su contraseña que usa para iniciar sesión en Merchant Portal. Luego haga clic en Delete.

   

   Después de la confirmación, la clave API se elimina permanentemente.