Referencia del API

El API Flux está organizada en torno a REST. Nuestra API tiene URL predecibles orientadas a recursos, acepta cuerpos de solicitud codificados en formulario, devuelve respuestas codificadas en JSON y utiliza verbos, autenticación y códigos de respuesta HTTP estándar.

Puede usar la API Flux en modo sandbox, que no afecta sus datos en producción ni interactúa con las redes de wallets.

Autenticación

El API de Flux usa un token de acceso (access token) para autenticar solicitudes. El equipo de Flx le proporcionará un token de actualización (refresh token) y este token de actualización se utilizará para obtener su token de acceso utilizando el endpoint adecuado.

Su token de actualización del API tiene muchos privilegios, ¡así que asegúrese de mantenerlos seguros! No comparta su token de actualización secreto en áreas de acceso público como GitHub, código del lado del cliente, etc.

Todas las solicitudes de API deben realizarse a través de HTTPS. Las solicitudes de API sin autenticación también fallarán.

Errores

Flux utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API. En general: los códigos en el rango 2xx indican éxito. Los códigos en el rango 4xx indican un error del lado del cliente (por ejemplo, se omitió un parámetro requerido, falló una carga, etc.). Los códigos en el rango 5xx indican un error con los servidores de Flux (estos son raros).

Algunos errores 4xx que podrían manejarse mediante programación (por ejemplo, un qr es rechazado) incluyen un código de error que explica brevemente el error reportado.