Wie verwendet man die API?

Die API wird durch einen Api-Key für Hero Cash gesichert.

Falls du noch keinen Api-Key hast, kannst du dieser Anleitung folgen.

Sicherheit

Dein Api-Key ist eine sensible Information, du solltest ihn geheim und sicher aufbewahren!

API-Endpunkt

Unsere API ist in zwei verschiedenen Umgebungen verfügbar:

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

Verwende Staging für Tests (in dieser Umgebung werden keine Geldtransfers durchgeführt), aber vergiss nicht, in deiner Produktionsumgebung den Produktions-Endpunkt zu verwenden!

Graphql

Vielleicht hast du bemerkt, dass wir nicht REST verwenden, sondern auf GraphQL für unsere API setzen.

GraphQL läuft über HTTP, sodass du GraphQL nicht kennen musst, um unsere API zu nutzen, aber es gibt einige Unterschiede, die du kennen solltest:

• GraphQL verwendet keinen HTTP-Status. Du solltest die Daten, die wir dir senden, überprüfen, um sicherzustellen, dass keine Fehler vorliegen.
• Mit GraphQL kannst du jeden Datensatz auswählen, den du erhalten möchtest.
• GraphQL ist typisiert, sodass du vorhersehbare API-Ergebnisse erhalten kannst.

Ratenbegrenzung

warning

Alle Endpunkte unserer Plattform haben eine Ratenbegrenzung. Wenn du das Limit überschreitest, erhältst du einen 429 HTTP-Statuscode.

Du kannst bis zu 1800 Anfragen pro Minute und 200 Anfragen pro Sekunde stellen.

Darüber hinaus können einige Operationen aufgrund der Datenabrufzeit lange dauern. Wenn du Massenoperationen durchführen möchtest, wird empfohlen, die Größe der Massen zu minimieren und die Anzahl der Aufrufe zu erhöhen, um eine schnellere Antwortzeit zu erhalten.

Lass uns einen Aufruf machen

GraphQL läuft über HTTP, es ist also im Grunde eine einfache Anfrage wie:

• 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