Zum Inhalt springen

Blockchain-API-Schnellstart und API-Keys

Die Chaingateway-API ist eine REST-API, die Wallets erstellt, Transaktionen sendet, Guthaben liest und Webhooks für mehrere Blockchains über HTTPS und JSON liefert. Für den Aufruf benötigen Sie ein Konto, einen API-Token und einen HTTP-Client. Diese Anleitung behandelt alle drei und endet mit einer ersten Anfrage, die eine Ethereum-Adresse erstellt.

Anfrageablauf: Ihre Anwendung sendet eine HTTPS-Anfrage mit Bearer-Token und optionalem Header X-Network an die Chaingateway-API, die die Blockchain abfragt und mit JSON antwortet Ihre Anwendung HTTP-Client: curl, requests, axios, Guzzle HTTPS-Anfrage anapp.chaingateway.io/api/v2/{chain}/... Authorization: Bearer-Token, optionalX-Network: testnet Chaingateway-API prüft Token und Body, spricht mit derBlockchain JSON-Antwort status, ok, message, data
Was bei jedem Aufruf der API passiert.

Registrieren Sie ein Konto, öffnen Sie die API-Key-Seite und erstellen Sie einen Token. Ein neues Konto startet mit einer 7-tägigen kostenlosen Testphase, zum Einstieg ist keine Karte nötig. Erstellen Sie Ihr Konto unter Chaingateway-Konto oder melden Sie sich an und öffnen Sie dann die API-Key-Seite.

Geben Sie dem Token einen Namen und klicken Sie auf „+ Create Token“. Der neue Token erscheint in der Liste. Bewahren Sie ihn an einem sicheren Ort auf und geben Sie ihn nicht weiter. Wer den Token besitzt, kann die API mit Ihrem Konto aufrufen. Halten Sie ihn deshalb aus der Versionsverwaltung heraus und laden Sie ihn aus einer Umgebungsvariablen oder einer .env-Datei.

Jeder Client, der HTTPS-Anfragen senden kann, funktioniert. Die API-Referenz erzeugt Beispiele für viele weitere Sprachen als diese Seite. Die Beispiele hier verwenden diese Clients:

Die API folgt der HTTP-Methodensemantik aus RFC 9110. Ressourcen wie addresses, transactions und webhooks liegen unter /api/v2/{chain}/, und die Methode bestimmt, was mit der Ressource geschieht. Antworten sind JSON.

MethodeBedeutungBeispiel in dieser API
GETEine Ressource oder eine Liste lesenGET /api/v2/ethereum/addresses listet Ihre Adressen auf
POSTEine Ressource erstellen oder eine Aktion auslösenPOST /api/v2/ethereum/addresses erstellt eine Adresse
PUTDie Felder einer bestehenden Ressource ersetzenPUT /api/v2/ethereum/webhooks/{id} aktualisiert einen Webhook
DELETEEine Ressource entfernenDELETE /api/v2/ethereum/addresses/{address} löscht eine Adresse

Eine Adresse lässt sich nicht bearbeiten, weil ihre Schlüssel sie definieren, daher gibt es für Adressen kein PUT und kein PATCH. Das Passwort eines gespeicherten Schlüssels ist die Ausnahme und ändert sich über POST /api/v2/{chain}/addresses/{address}.

Senden Sie drei Header: Authorization, Accept und, wenn die Anfrage einen Body hat, Content-Type. Ein optionaler vierter Header, X-Network, wählt das Testnetz.

  • Authorization: Bearer YOUR_API_TOKEN überträgt Ihren Token als Bearer-Token, wie in RFC 6750 definiert. Eine Anfrage ohne gültigen Token erhält HTTP 401 und den Body {"message":"Unauthenticated."}.
  • Accept: application/json fordert eine JSON-Antwort an.
  • Content-Type: application/json teilt dem Server mit, dass der Request-Body JSON ist. Die API akzeptiert auch formularkodierte Bodys, die Beispiele verwenden aber JSON.
  • X-Network: testnet führt die Anfrage im Testnetz aus. Lassen Sie den Header weg oder senden Sie mainnet, um das Hauptnetz zu nutzen. Die Netzwerktabelle listet die Netzwerke hinter jedem Wert auf.

Erstellen Sie eine Ethereum-Adresse mit einer POST-Anfrage. Der Body ist ein JSON-Objekt mit einem Feld, password. Es schützt den privaten Schlüssel, den Chaingateway für diese Adresse speichert, und Sie brauchen es erneut, sobald Sie von der Adresse eine Transaktion senden. Wallet-Verwaltung erklärt, was geschieht, wenn Sie es weglassen.

Terminal-Fenster
curl --request POST \
--url https://app.chaingateway.io/api/v2/ethereum/addresses \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"password": "choose-a-strong-password"
}'

Ein erfolgreicher Aufruf liefert Status 201. Die OpenAPI-Datei schreibt den Schlüssel des Adressfelds adderess, lesen Sie ihn daher unter diesem Namen:

{
"status": 201,
"ok": true,
"message": "Address created",
"data": {
"adderess": "0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8"
}
}

Zum Lesen von Daten verwenden Sie GET, das keinen Request-Body hat. Der nächste Aufruf listet die Adressen auf, die Sie erstellt und nicht gelöscht haben.

Terminal-Fenster
curl --request GET \
--url https://app.chaingateway.io/api/v2/ethereum/addresses \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Accept: application/json'

Wie führe ich denselben Aufruf in einem Testnet aus?

Abschnitt betitelt „Wie führe ich denselben Aufruf in einem Testnet aus?“

Fügen Sie den Header X-Network: testnet hinzu und behalten Sie alles andere bei. Die Adresse wird dann auf Sepolia erstellt, und Test-Coins haben keinen Marktwert. Nutzen Sie das Testnet, bis Ihre Integration die Erfolgs- und Fehlerantworten korrekt verarbeitet. Später auf das Hauptnetz zu wechseln bedeutet, den Header zu entfernen oder auf mainnet zu setzen.

Fehler verwenden denselben JSON-Umschlag wie erfolgreiche Aufrufe, mit ok auf false. Die OpenAPI-Datei dokumentiert die Statuscodes 200, 201, 400, 401, 404 und 422. Ein Validierungsfehler listet die abgelehnten Felder auf:

{
"status": 422,
"ok": false,
"message": "Data validation failed",
"errors": {
"password": ["The password field is required."]
}
}

Blockchain-Fehler kommen auf dieselbe Weise an. Eine Transaktion ohne ausreichendes Guthaben für Gas liefert 422 mit der Meldung des Nodes, und ein falsches Wallet-Passwort liefert 401 mit Wrong password provided. Protokollieren Sie bei jedem fehlgeschlagenen Aufruf message und errors, denn sie nennen meist das Feld oder die Ursache.