Una clave API permite que una aplicación acceda a partes de tu cuenta de BitcoinVN. Trata cada clave como una contraseña: quien la obtenga podría consultar información de la cuenta o realizar las acciones permitidas por sus permisos.
Crea y etiqueta una clave
Antes de crear una clave, confirma que esté activa la cuenta principal o la subcuenta VIP correspondiente.
Después:
- Abre Administrar claves API.
- Selecciona Generar nueva clave.
- Copia la clave en la aplicación que la utilizará.
- Selecciona Editar.
- Añade una etiqueta que identifique la aplicación o el propósito.
- Elige los permisos y las restricciones de IP opcionales y guarda.
Utiliza una clave distinta para cada aplicación, de modo que puedas restringir o revocar una integración sin afectar a las demás. No incluyas secretos ni información personal en la etiqueta.
Elige los permisos mínimos necesarios
BitcoinVN ofrece dos niveles de permisos:
- Solo lectura: Puede consultar datos de la cuenta, pero no crear órdenes.
- Lectura y escritura: Puede consultar datos de la cuenta y crear órdenes.
Una clave de lectura y escritura puede usar el saldo de tu cuenta para crear órdenes y enviar los fondos resultantes a un destino de liquidación. Quien obtenga dicha clave podría retirar tus fondos.
Usa el acceso de solo lectura salvo que la aplicación realmente necesite crear órdenes.
Restringe el acceso por dirección IP
Puedes limitar una clave a direcciones IP específicas desde su página de edición:
- Introduce una dirección IP por línea.
- Añade solo las direcciones utilizadas por la aplicación correspondiente.
- Deja el campo vacío únicamente si la aplicación no puede utilizar una dirección IP estable.
Las solicitudes de otras direcciones no serán aceptadas mientras haya una restricción de IP configurada. Actualiza la lista si cambia la dirección de la aplicación.
Usa la clave con la API
Envía la clave en el encabezado de solicitud X-API-KEY:
X-API-KEY: <your-api-key>El marcador anterior es solo un ejemplo. Nunca incluyas una clave real en código público, capturas de pantalla, mensajes de soporte, aplicaciones ejecutadas en el navegador, URL ni registros.
La documentación interactiva de la API está disponible en bitcoinvn.io/api/doc.
Comprende el contexto de las subcuentas
Una clave API permanece asociada a la cuenta que estaba activa cuando se creó:
- Las claves creadas en la cuenta principal utilizan la cuenta principal.
- Las claves creadas mientras una subcuenta está activa utilizan esa subcuenta.
Cambiar de cuenta en el sitio web no modifica una clave existente. Verifica la cuenta activa antes de generarla.
Revoca o reemplaza una clave
Abre Administrar claves API y selecciona Revocar junto a una clave que ya no necesites. La revocación no se puede deshacer.
Si una clave puede haber quedado expuesta:
- Revócala.
- Genera un reemplazo.
- Aplica los permisos y las restricciones de IP necesarios.
- Actualiza la aplicación correspondiente.
Nunca envíes una clave API al soporte de BitcoinVN ni a nadie que afirme representar a BitcoinVN.