Einleitung
Die heiminfo.ch ReST-API stellt Ihnen die nötigen Ressourcen für die Erstellung und Abfrage von Stelleninseraten eines oder mehrerer Stellenmarkt-Kunden zur Verfügung.
Authentifizierung / API-Key
Für sämtliche Anfragen an die API muss ein API-Key als Request-Header mitgegeben werden. Der API-Key legt fest, welche Daten abgefragt werden dürfen.
Um einen API-Key zu beantragen, wenden Sie sich bitte an:
webways ag
Telefon 061 695 99 99
E-Mail: api@webways.ch
Versionierung
Die API Versionierung entspricht dem Semantic Versioning.
Die Angabe der Version im Request-Header ist zwingend. Hier muss die MAJOR Versionsnummer angegeben werden, also beispielsweise 1 für die Version 1.2.23
Basis-URL
Sämtliche Ressourcen werden über die Basis-URL https://www.heiminfo.ch/api angesprochen.
Unter https://dev.heiminfo.ch/api steht ein Testsystem zur Verfügung.
Globale Request Header
Folgende Request Header müssen bei sämtlichen Anfragen mitgesendet werden:
| Name | Wert(e) | Erforderlich | Hinweis(e) |
|---|---|---|---|
| apiKey | [apiKey] | Pflicht | siehe API-Key |
| version | 1 | Pflicht | siehe auch Versionierung |
Weitere Parameter/Request Header
Optional können weitere Parameter/Request Header in Abhängigkeit der Ressource mitgegeben werden. Entsprechende Hinweise zu den möglichen Parametern finden Sie bei der Beschreibung der jeweiligen Ressource (siehe nachfolgend).
OpenAPI / Swagger
Die Definition der API im OpenAPi Format als JSON steht unter https://www.heiminfo.ch/assets/openapi.json zur Verfügung.
Diese ist auch mit einem Userinterface unter
https://www.heiminfo.ch/apidocs/redoc
oder
https://www.heiminfo.ch/apidocs/swaggerui
verfügbar.