Self-Service Documentation

Atlatos REST API – Mitarbeitermanagement (Public API)

Diese Dokumentation beschreibt die Nutzung der öffentlichen Atlatos REST API für das Mitarbeitermanagement.

Die Schnittstelle ist so konzipiert, dass Unternehmen sowie Reisebüros Mitarbeitende anlegen, aktualisieren und löschen können.

Das Dokument enthält technische und allgemeine Informationen zur Funktionalität der Atlatos REST API und richtet sich an technisches Personal mit Kenntnissen in JSON und REST.

Für die technische Implementierung ist die bereitgestellte OpenAPI-Dokumentation maßgeblich.

Die vollständige technische Dokumentation findest du hier:
https://api.atlatos-traveller.de/self-service/swagger-ui.html

Systemzugang

Zugangsdaten (Credentials)

Die Zugangsdaten werden von Atlatos bereitgestellt und bestehen aus einem API-Key/Secret-Paar, das im HTTP-Header der Anfrage mitgesendet werden muss.

Endpoint / Umgebung

Um die REST API zu verwenden, nutze folgende URL:

• LIVE: https://api.atlatos-traveller.de/self-service/employee

• TEST: TBD (noch festzulegen)

Die OpenAPI-Spezifikation ist hier verfügbar:
https://api.atlatos-traveller.de/self-service/swagger-ui.html

Funktionalität

Mitarbeitende anlegen und aktualisieren

• Zum Anlegen eines neuen Mitarbeiters muss ein POST auf den Endpoint /employee erfolgen.

• Zum Aktualisieren eines bestehenden Mitarbeiters muss ein PUT auf den Endpoint /employee erfolgen.

Besonderheiten beim Erstellen oder Aktualisieren eines Users:

• username muss innerhalb des Unternehmens eindeutig sein.

• Benennung von branch / department muss mit Atlatos übereinstimmen.

• Wenn eine department innerhalb einer branch nicht gefunden wird, wird sie neu angelegt.

• Wenn eine branch in Atlatos nicht gefunden wird, wird nach der eindeutigen department gesucht.

JSON-Request mit Pflichtfeldern

{
  "username": "API-User",
  "title": "Mr",
  "firstname": "Atlatos",
  "lastname": "GmbH",
  "email": "info@atlatos.com",
  "branch": "Atlatos GmbH",
  "department": "Default"
}

Zugriffsrechte anlegen

Für jeden User können Zugriffsrechte ergänzt werden.
Diese müssen im Employee-Request im Feld access_rights mitgegeben werden.

JSON-Request mit Zugriffsrechten

{
  "username": "API-User",
  "title": "Mr",
  "firstname": "Atlatos",
  "lastname": "GmbH",
  "email": "info@atlatos.com",
  "branch": "Atlatos GmbH",
  "department": "Default",
  "access_rights": [
    {
      "username": "Super-User",
      "access_type": "BOOK"
    },
    {
      "username": "Super-User",
      "access_type": "EXPENSE",
      "level": 1,
      "mail": false
    }
  ]
}

Felder innerhalb access_rights

• username
  Eindeutiger Username der vorgesetzten Person.

• branch
  Falls der Username nicht eindeutig ist, kann die Branch angegeben werden.

• access_type
  Mögliche Werte: BOOK, REPORT, TRAVEL_REQUEST, EXPENSE

• level
  Genehmigungsstufe (nur für TRAVEL_REQUEST und EXPENSE).

• mail
  Gibt an, ob eine E-Mail versendet werden soll (nur für TRAVEL_REQUEST und EXPENSE).
  Standard: false

Mitarbeitende löschen

Zum Löschen eines Mitarbeiters muss ein DELETE auf den Endpoint /employee erfolgen.