Zum Hauptinhalt springen

Konfiguration

Wie bereits einleitend erwähnt legt der verwendete API-Key fest, welche Daten über die API abgefragt und/oder bewirtschaftet werden können.

Basis-URL

Jeder API-Key ist auf einen der vier Stellenmärkte eingeschränkt. Das heisst, dass beispielsweise nur Daten von www.sozjobs.ch abgefragt werden können, nicht aber von www.spitexjobs.ch. Verwenden Sie deshalb als Basis-URL für Ihre Anfragen die URL des Stellenmarktes, welcher dem API-Key zugeordnet ist.

Kundenzuordnung

In der Regel erlaubt Ihnen der API-Key den Zugriff auf die Daten eines einzelnen Stellenmarkt-Kunden. In Einzelfällen ist es auch möglich, dass der Zugriff auf mehrere Kunden freigeschaltet ist.

Für die eindeutige Zuweisung zu einem Kunden ist es deshalb bei gewissen Ressourcen erforderlich, dass zusätzlich zum API-Key auch die 'identityNumber' des Kunden mitgegeben wird. Ist dies der Fall, finden Sie entsprechende Hinweise bei den betreffenden Ressourcen.

Kundendaten abfragen

Welche Kunden Ihrem Api-Key zugeordnet sind, können Sie über die Ressourcen unter /clients sowie /configuration abfragen.

Kundendaten ändern

Die Kundendaten können bislang nicht über die API geändert werden. Bitte nutzen Sie die regulären Logindaten des Kunden, um sich am betreffenden Stellenmarkt anzumelden und die Angaben unter «Kundenangaben» manuell zu ändern.

Weiterführende Infos

Weitere, detaillierte Informationen entnehmen Sie bitte der API-Definition im OpenAPI-Format, siehe OpenAPI.