1. Grundlagen

1.1. RESTful Webservice

Die HypService-API ist als sogenannter RESTful Webservice angelegt, bei dem jede Ressource über eine eindeutige URI angesprochen wird. Welche Operationen mit den Ressourcen durchgeführt werden, wird mittels der HTTP-Verben angegeben:

  • GET: Ressourcen lesen
  • POST: Ressourcen erstellen
  • PUT: Ressourcen bearbeiten
  • DELETE: Ressourcen löschen
  • HEAD: Nur Header-Daten lesen

HypService versteht für schreibende Requests das Format JSON. Der entsprechende Content-Type muss im HTTP-Header gesetzt werden (application/json).

Responses werden im JSON-Format erfolgen. Für spezielle Ressourcen sind auch weitere Formate mögliche (z.B. PDF).

1.2. Sicherheit

Der Zugriff auf die API erfolgt verschlüsselt über https, da die Daten ansonsten im Klartext übertragen werden und potentiell mitgelesen werden können.

1.3. Authentifizierung

Zur Sicherung der Schnittstellen und der Webanwendungen verwenden wir einen Single Sign On Server, über den jeder Zugriff authentifiziert und autorisiert werden muss. Der Server unterstützt OpenID Connect und OAuth2.

Die Authentifizierung von Anwendungen läuft über den OAuth2 Flow vom Typ „Resource owner password“.

Hinweise:

1.3.1. Credentials

Um die Credentials zu erhalten, erfragen Sie beim Support der Plattform die Zugangsdaten zum Nutzen der API, bzw. bitten Ihren Auftraggeber dies zu tun. Sie erreichen den Support unter support@hypservice.de.

1.3.2. Schritte

  1. Absenden eines POST Requests auf den Login-Endpunkt mit Username und Password.
  2. Aus der JSON-Antwort das JWToken (access_token) entnehmen
  3. Bei weiteren Requests muss dieses JWToken als Authorization Header mitgeschickt werden.
Hinweise:

Cookies helfen uns bei der Bereitstellung unserer Dienste. Durch die Nutzung unserer Dienste erklären Sie sich damit einverstanden, dass wir Cookies setzen. Mehr Informationen

The cookie settings on this website are set to "allow cookies" to give you the best browsing experience possible. If you continue to use this website without changing your cookie settings or you click "Accept" below then you are consenting to this.

Close