Dokumentation

Erste Schritte

Konventionen

  • Alle Pfade unten sind relativ zur Basis-URL. Anfragen und Antworten sind JSON; senden Sie bei POST Content-Type: application/json.
  • IDs sind UUIDs. Zeitstempel sind ISO 8601 in UTC.
  • Platzhalter werden über ihren Schlüssel angesprochen, einen snake_case-Namen wie client_name, den der Vorlagen-Endpunkt neben jeder Bezeichnung zurückgibt. Er wird beim ersten Speichern der Vorlage aus der Bezeichnung abgeleitet und bleibt bestehen, wenn die Bezeichnung umformuliert wird; der Autor kann ihn in der Vorlage ändern.
  • Antworten tragen Cache-Control: no-store und großzügige CORS-Header, sodass ein Browser-Client funktioniert; ein Browser ist aber der falsche Ort für ein API-Token.
  • Die API ist im Pfad versioniert. Antworten können ohne Versionswechsel um Felder ergänzt werden; innerhalb von v1 wird nichts entfernt oder umbenannt.