Entwicklerdokumentation

API-Arbeitsbereich
https://api.rentron.xyz/v1
OpenAPI-Schema

Bestellung abrufen

// GET

Produktions-API

Bestellung abrufen

Eine eigene Bestellung lesen, den Moment erkennen, ab dem die Energy nutzbar ist, und feststellen, ob Lieferung und Mietzyklus endgültig sind.

GET /v1/energy/orders/{id}
Auf dieser Seite

Verwenden Sie die UUID aus dem Anlegen der Bestellung oder den Pfad aus deren Location-Header.

Pfadparameter

Parameter Typ Beschreibung
id UUID Öffentliche Kennung der Bestellung.

Antwort 200

{"id":"7c0c9a54-517c-4bbb-a946-bf14bf86c113","client_request_id":"order-1042","address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","energy":65000,"duration_minutes":60,"total_trx":"3.200000","status":"delivered","lifecycle_final":false,"delivery_final":true,"created_at":1784376000,"updated_at":1784376073,"energy_usable":true,"rental_expires_at":1784379612}

Ein Feld ohne Wert fehlt in der Antwort, statt als null gesendet zu werden: eine Bestellung, die noch keine Adresse erreicht hat, trägt überhaupt keinen Schlüssel rental_expires_at, eine erfolgreiche keinen Schlüssel failure. Lesen Sie einen fehlenden Schlüssel als null und setzen Sie ihn nicht voraus.

Feld Typ Beschreibung
status string created, executing, available, delivered, rental_finished, failed oder rental_interrupted.
energy_usable boolean Die Energy liegt auf der Adresse und kann ausgegeben werden. true in available und in delivered, solange rental_expires_at noch bevorsteht, und false nach diesem Zeitpunkt — der Status zeigt dann noch eine Weile delivered, weil das Ende der Miete anhand bereits finalisierter Daten aus dem Netzwerk bestätigt wird.
rental_expires_at integer, fehlt ohne Wert Unix-Sekunden, zu denen das bezahlte Mietfenster endet. Fehlt, bis die Energy die Adresse erreicht, und fehlt erneut bei failed: dort wird der reservierte Betrag vollständig freigegeben und das Fenster mit ihm aufgehoben. Bei rental_interrupted bleibt das Fenster stehen, in dem diese Miete vorzeitig endete.
lifecycle_final boolean Die Miete ist beendet, ein weiterer Übergang folgt nicht.
delivery_final boolean Der Lieferversuch ist beendet. In available noch false, weil die Lieferung dort noch nicht unabhängig bestätigt ist. true bedeutet für sich genommen keinen Erfolg; prüfen Sie failure.
failure object, fehlt ohne Wert Liegt bei failed mit code: energy_delivery_failed vor und bei rental_interrupted mit code: energy_delivery_interrupted. In beiden Fällen stehen darin dieser stabile code und eine gefahrlos lesbare message.
created_at, updated_at integer Unix-Sekunden.

Wann Sie Ihre Transaktion senden

Richten Sie sich nach energy_usable, nicht nach delivered.

{"status":"available","lifecycle_final":false,"delivery_final":false,"energy_usable":true,"rental_expires_at":1784379612}

available bedeutet, dass die Energy der Adresse bereits zugeteilt ist und ausgegeben werden kann; das bezahlte Fenster läuft bis rental_expires_at. Etwa eine Minute später löst delivered diesen Status ab, sobald eine unabhängige Prüfung die Lieferung belegt; rental_expires_at verschiebt sich dabei nicht. Auf delivered zu warten kostet nur Mietzeit, die bereits bezahlt ist.

Wann das Polling endet

Hören Sie erst auf, wenn beide Endflags true sind. Ein vollständig erfolgreicher Zyklus endet als rental_finished. failed und rental_interrupted enthalten failure.

Nicht gefunden

Unbekannte IDs und IDs fremder Konten liefern bewusst dieselbe Antwort:

{"type":"https://rentron.xyz/docs/errors/codes#energy_order_not_found","title":"Not Found","status":404,"detail":"Order was not found.","code":"energy_order_not_found"}