API Benutzerdokumentation: Unterschied zwischen den Versionen
Ivan (Diskussion | Beiträge) Die Seite wurde neu angelegt: „Category:Bewerbermanagement Category:Schnittstellen =Kurzanleitung= Die Umantis ATS API bietet eine Sammlung von API Endpunkten, die die Integration zwischen dem Umantis ATS und anderen Anwendungen innerhalb der Infrastruktur unserer Kunden unterstützt. ==Allgemeine Informationen== Die technische Dokumentation der API kann über den Endpunkt /openapi abgerufen werden. Die API bietet die Möglichkeit, verschiedene Ressourcentypen abzurufen, zu…“ |
Ivan (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 14: | Zeile 14: | ||
Die Antwort wird in JSON zurückgegeben, und zwar gemäss der [https://jsonapi.org/format/#document-structure JSON:API-Dokumentstruktur]. In den meisten Fällen ist es möglich, die auszugebenden Datensätze zu filtern. Felder, nach denen gefiltert werden kann, sind durch den Tag #filterable gekennzeichnet. | Die Antwort wird in JSON zurückgegeben, und zwar gemäss der [https://jsonapi.org/format/#document-structure JSON:API-Dokumentstruktur]. In den meisten Fällen ist es möglich, die auszugebenden Datensätze zu filtern. Felder, nach denen gefiltert werden kann, sind durch den Tag #filterable gekennzeichnet. | ||
Zusätzlich ist es auch möglich, über den Query-Parameter "fields[RELATIONSHIP]" die auszugebenden Felder innerhalb eines Datensatzes zu filtern. Weitere Informationen sind in der technischen Dokumentation unter <LINK zur SWAGGER Dokumentation> zu finden. | Zusätzlich ist es auch möglich, über den Query-Parameter "fields[RELATIONSHIP]" die auszugebenden Felder innerhalb eines Datensatzes zu filtern. Weitere Informationen sind in der technischen Dokumentation unter <LINK zur SWAGGER Dokumentation> zu finden. | ||
==Aufbau Lösungs-URL== | |||
Der Aufbau der URL der Umantis Lösungen ist immer gleich: | |||
* <nowiki>https://recruitingapp-<TenantID>(.de).umantis.com</nowiki> | |||
Die '''TenantID''' ist die eindeutige Lösungsnummer jeder Lösung und identifiziert den dahinterliegenden Kunden oder Partner. | |||
Lösungen die in Deutschland gehostet werden, enthalten ein zusätzliches ".de" zwischen der TenantID und der Domain <nowiki>.umantis.com</nowiki>. Bei Lösungen, die in der Schweiz gehostet werden, entfällt dieser Zusatz. | |||
==Authentifizierung== | |||
Die Authentifizierung folgt dem [https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow Client Credentials Flow]. Das OAuth Token wird über den Endpunkt '''/oauth/token''' generiert. Dazu werden valide Login-Informationen benötigt: | |||
: '''client_id''' = <Benutzer-Login> | |||
: '''client_secret''' = <Passwort> | |||
: '''grant_type''' = "client_credentials" | |||
curl --location 'https://recruitingapp-<TenantID>.umantis.com/api/v1/oauth/token' \ | |||
--header 'Content-Type: application/x-www-form-urlencoded' \ | |||
--header 'Accept: application/json' \ | |||
--data-urlencode 'client_id=max.mustermann' \ | |||
--data-urlencode 'client_secret=abc123!' \ | |||
--data-urlencode 'grant_type=client_credentials' | |||
Version vom 22. Januar 2025, 12:00 Uhr
Kurzanleitung
Die Umantis ATS API bietet eine Sammlung von API Endpunkten, die die Integration zwischen dem Umantis ATS und anderen Anwendungen innerhalb der Infrastruktur unserer Kunden unterstützt.
Allgemeine Informationen
Die technische Dokumentation der API kann über den Endpunkt /openapi abgerufen werden.
Die API bietet die Möglichkeit, verschiedene Ressourcentypen abzurufen, zu erstellen oder zu ändern. Die folgenden Punkte sind für alle Anfragen obligatorisch:
- Clients MÜSSEN den Accept http-Header bereitstellen, in der Regel mit application/vnd.api+json als Medientypbezeichnung.
Im Falle des Medientyps application/vnd.api+json sind keine Medientypparameter zulässig. - Clients MÜSSEN den Authorization http-Header bereitstellen, wie im Abschnitt „Authentifizierung“ beschrieben.
Die Antwort wird in JSON zurückgegeben, und zwar gemäss der JSON:API-Dokumentstruktur. In den meisten Fällen ist es möglich, die auszugebenden Datensätze zu filtern. Felder, nach denen gefiltert werden kann, sind durch den Tag #filterable gekennzeichnet. Zusätzlich ist es auch möglich, über den Query-Parameter "fields[RELATIONSHIP]" die auszugebenden Felder innerhalb eines Datensatzes zu filtern. Weitere Informationen sind in der technischen Dokumentation unter <LINK zur SWAGGER Dokumentation> zu finden.
Aufbau Lösungs-URL
Der Aufbau der URL der Umantis Lösungen ist immer gleich:
- https://recruitingapp-<TenantID>(.de).umantis.com
Die TenantID ist die eindeutige Lösungsnummer jeder Lösung und identifiziert den dahinterliegenden Kunden oder Partner. Lösungen die in Deutschland gehostet werden, enthalten ein zusätzliches ".de" zwischen der TenantID und der Domain .umantis.com. Bei Lösungen, die in der Schweiz gehostet werden, entfällt dieser Zusatz.
Authentifizierung
Die Authentifizierung folgt dem Client Credentials Flow. Das OAuth Token wird über den Endpunkt /oauth/token generiert. Dazu werden valide Login-Informationen benötigt:
- client_id = <Benutzer-Login>
- client_secret = <Passwort>
- grant_type = "client_credentials"
curl --location 'https://recruitingapp-<TenantID>.umantis.com/api/v1/oauth/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Accept: application/json' \ --data-urlencode 'client_id=max.mustermann' \ --data-urlencode 'client_secret=abc123!' \ --data-urlencode 'grant_type=client_credentials'