CASYMIR REST API - Standard - Introduction
Die Standard-Endpunkte stehen auf jedem CASYMIR Applikationsserver zur Verfügung.
Standard Methoden
Diese stehen grundsätzlich zur Verfügung
OPTION
- Steht an jeden Endpunkt zur Verfügung
- Liefert die erlaubten Methoden zurück
HEAD
- Steht an jeden Endpunkt mit Get zur Verfügung
- Liefert den Header zurück ohne Body
TRACE
- Steht an jeden Endpunkt zur Verfügung
- Schickt den Anfrage Header unverändert zurück
GET
- Endpunkt Spezifisch
- Liefert Informationen zurück, verändert keine Daten
POST
- Endpunkt Spezifisch
- Erzeugt eine neue Ressource und liefert in Location den Bezug zurück
PUT
- Endpunkt Spezifisch
- Überschreibt eine bestehende Ressource
DELETE
- Endpunkt Spezifisch
- Entfernt eine Ressource liefert den Code 204 zurück
PATCH
- Endpunkt Spezifisch
- Updatet eine Ressource nicht angegebene Daten werden beibehalten
Authorization - Request for Token
Methode: POST URL/www/token
BASIC Verfahren
Header-Field
Authorization: Basic BASE64(USERNAME:PASSWORT)
BASIC benötigt nur ein Header
OAuth2.0 Client Credentials Grant Verfahren
Header-Field
Content-Type: application/x-www-form-urlencoded
Body Text
grant_type=client_credentials&client_secret=PASSWORT&client_id=USERNAME
OAuth2.0 benötigt ein Header und Body
OAuth2.0 Resource Owner Password Credentials Grant
Header-Field
Content-Type: application/x-www-form-urlencoded
Body Text
password=PASSWORD&grant_type=password&client_secret=CONFIG-SECRET&client_id=CONFIG-ID&username=USERNAME
Bei OAuth2.0 Resource Owner Password Credentials Grant wird neben den UserName und Password auch noch der client_secret und client_id benötigt welcher in der Rest-Config Festgelegt werden kann
Response in Json
{
"expires_in": "***",
"access_token": "****"
}
- expires_in: Zeit in Sekunden wie lange der Token Gültigkeit hat
- access_token: der Token
Autorisierung am Endpoint
Header-Field
Authorization: Bearer ACCESS_TOKEN
Wenn in den Einstellungen zugelassen ist eine Verbindung auf die Endpunkte mit Base möglich.
Authorization: Basic BASE64(USERNAME:PASSWORT)
Header-Fields
Request
Content-Type:
- Typ mit welcher die Anfrage gestellt wird und in welcher geantwortet wird, betrifft den Body
- Beispiele:
- Content-Type: application/json;charset=utf-8
- Content-Type: application/xml
Accept:
- Wird vom Client geschickt, mit Bitte um Antwort in diesen Content-Type
- Beispiele:
- Accept: application/json
- Accept: application/xml
Content-Length:
- Länge des Bodys
- Beispiel:
- Content-Length: 1546
Authorization:
- Angabe zur Autorisierung (Basic, Bearer)
- Beispiel:
- Authorization: Basic 3DEWASW=
Accept-Charset:
- Gewünschte Charset
- Beispiel:
- Accept-Charset: UTF-8
- Accept-Charset: ISO-8859-1
X-HTTP-Method-Override:
- wird genutzt um die Methode zu Übersteuern, Tunneln
- Beispiel: PUT
X-Debug:
- Übersteuert das Debug-Level, welches zur URI hinterlegt ist
- Beispiele:
- ab Debug-Level 6: Logging in casy.log
- ab Debug-Level 7: Logging im Filesystem
Body
* data table enthält die Daten aus der Abfrage.
* data_error table Optional, enthält Fehler die Aufgetreten sind.
* count int Anzahl der Einträge in data.
* success bool Ausgabe ob der Aufruf ohne Fehler erfolgt ist.
* pagination table Spezialangabe Seiten wahl.
Response
Date:
- Datum und Zeit vom Server
Content-MD5:
- Prüfwert zum Body
Cache-Control:
- Steuerung eines Cache
Etag:
- Eindeutige Tag zur Abfrage, zur Validierung ( Starke Tag )
X-Start-End:
- Berechnung der Zeit für die Ermittlung der Abfrage.
Copyright (c) casymir schweiz ag, 2024
CASYMIR REST API wurde entwickelt, unter Mitwirkung von:
- casymir schweiz ag, CH-4144 Arlesheim
- SIGMATECH Informatik GmbH, DE-66359 Bous