Saltar al contenido principal

¿Cómo usar la API?

La API está protegida por una Api-Key para Hero Cash.

Si aún no tienes una Api-Key, puedes seguir esta guía.

Seguridad

¡Tu Api-Key es información sensible, debes mantenerla secreta y segura!

Endpoint de la API​

Nuestra API está disponible en dos entornos diferentes:

  • Producción: https://api.hero.fr/api/graphql
  • Staging: https://staging.api.hero.fr/api/graphql

Utiliza staging para realizar algunas pruebas (no habrá transferencia de dinero en este entorno), ¡pero no olvides usar el endpoint de Producción en tu entorno de producción!

Graphql​

Es posible que hayas notado que no usamos REST, sino que utilizamos GraphQL para nuestra API.

GraphQL transita a través de HTTP, por lo que no necesitas conocer GraphQL para usar nuestra API, pero hay algunas diferencias que debes conocer:

  • GraphQL no utiliza estados HTTP. Debes verificar los datos que te enviamos para asegurarte de que no hay errores.
  • Con GraphQL puedes elegir cada fragmento de datos que deseas recibir.
  • GraphQL está tipado, por lo que puedes obtener resultados predecibles de la API.

Límites de tasa​

warning

Todos los endpoints de nuestra plataforma tienen límites de tasa. Si excedes el límite, recibirás un código de estado HTTP 429.

Puedes realizar hasta 1800 solicitudes por minuto y 200 solicitudes por segundo

Además, algunas operaciones pueden tardar en procesarse debido a la recuperación de datos. Si planeas usar operaciones masivas, se recomienda minimizar el tamaño del lote y aumentar el número de llamadas para tener un tiempo de respuesta más rápido.

Hagamos una llamada​

GraphQL transita sobre HTTP, por lo que básicamente es una solicitud simple como:

  • Curl
  • Node.JS (axios)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: Api-Key <Your Api-Key>" \
    -d '{"query": "{ version }"}' \
    https://staging.api.hero.fr/api/graphql