Passa al contenuto principale

Come utilizzare l'API?

L'API è protetta da una Api-Key per Hero Cash.

Se non hai ancora una Api-Key, puoi seguire questa guida.

Sicurezza

La tua Api-Key è un'informazione sensibile, dovresti mantenerla segreta e al sicuro!

Endpoint API​

La nostra API è disponibile in due diversi ambienti:

  • Produzione: https://api.hero.fr/api/graphql
  • Staging: https://staging.api.hero.fr/api/graphql

Utilizza lo staging per fare alcuni test (non ci saranno trasferimenti di denaro in questo ambiente), ma non dimenticare di utilizzare l'endpoint di Produzione nel tuo ambiente di produzione!

Graphql​

Potresti aver notato che non utilizziamo REST, ma ci affidiamo a GraphQL per la nostra API.

GraphQL transita attraverso HTTP quindi non devi conoscere GraphQL per utilizzare la nostra API, ma ci sono alcune differenze che devi conoscere:

  • GraphQL non utilizza lo stato HTTP. Dovresti controllare i dati che ti inviamo per assicurarti che non ci siano errori.
  • Con GraphQL puoi scegliere ogni pezzo di dati che desideri ricevere.
  • GraphQL è tipizzato, quindi puoi avere risultati API prevedibili.

Limitazione delle richieste​

warning

Tutti gli endpoint della nostra piattaforma hanno una limitazione di richieste. Se superi il limite, riceverai un codice di stato HTTP 429.

Puoi effettuare fino a 1800 richieste al minuto e 200 richieste al secondo

Inoltre, alcune operazioni possono richiedere molto tempo per l'elaborazione a causa del recupero dei dati. Se prevedi di utilizzare operazioni in blocco, si consiglia di ridurre al minimo la dimensione del blocco e aumentare il numero di chiamate per avere un tempo di risposta più rapido.

Facciamo una chiamata​

GraphQL transita su HTTP, quindi è fondamentalmente una semplice richiesta come:

  • 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