From be1e5dda23b5bac86898ac548ca1ecd2e6a3fb08 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Thu, 2 May 2019 11:29:43 +0200 Subject: Public API documentation --- templates/account.html.ep | 69 +++-------------------------------------------- 1 file changed, 3 insertions(+), 66 deletions(-) (limited to 'templates/account.html.ep') diff --git a/templates/account.html.ep b/templates/account.html.ep index fc4387d..38ffecb 100644 --- a/templates/account.html.ep +++ b/templates/account.html.ep @@ -66,10 +66,10 @@ +

API

% my $token = get_api_token();
-

API

Die folgenden API-Token erlauben den passwortlosen automatisierten Zugriff auf API-Endpunkte. Bitte umsichtig behandeln – sobald ein Token gesetzt @@ -150,76 +150,13 @@

-% my $api_root = $self->url_for('/api/v1')->to_abs->scheme('https'); -

Status

-

- % if ($token->{status}) { - curl <%= $api_root %>/status/<%= $acc->{id} %>-<%= $token->{status} // 'TOKEN' %> - % } - % else { - curl <%= $api_root %>/status/TOKEN - % } -

-

- Beispiel / Layout: -

-

- {
- "deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)
- "checkedIn" : true / false,
- "fromStation" : { (letzter Checkin)
- "name" : "Essen Hbf",
- "ds100" : "EE",
- "uic" : 8000098,
- "latitude" : 51.451355,
- "longitude" : 7.014793,
- "scheduledTime": 1556083680,
- "realTime": 1556083680,
- },
- "fromStation" : { (zugehöriger Checkout. Wenn noch nicht eingetragen, sind alle Felder null)
- "name" : "Essen Stadtwald",
- "ds100" : "EESA",
- "uic" : 8001896,
- "latitude" : 51.422853,
- "longitude" : 7.023296,
- "scheduledTime": 1556083980, (ggf. null)
- "realTime": 1556083980, (ggf. null)
- },
- "train" : {
- "type" : "S", (aktueller / letzter Zugtyp)
- "line" : "6", (Linie als String, nicht immer numerisch, ggf. null)
- "no" : "30634", (Zugnummer als String)
- "id" : "7512500863736016593", (IRIS-spezifische Zug-ID)
- },
- "actionTime" : 1234567, (UNIX-Timestamp des letzten Checkin/Checkout)
- } -

-

- Im Fehlerfall: { "error" : "Begründung" } -

-
-
- +

Export

-- cgit v1.2.3