API Dokumentation

Lea
Lea
  • Aktualisiert

absence.io bietet eine RESTful API, mit der die meisten Abwesenheiten abgerufen, erstellt, aktualisiert oder gelöscht werden können.

Alle API-URLs findest du unter dem URL-Pfad https://app.absence.io/api/v2/[.....].

Die absence.io API unterstützt nur das JSON-Format zum Senden und Abrufen von Daten.

 

Einführung

Klick hier, um eigene absence.io-Plugins zu erstellen oder/und absence.io in kundenspezifische Systeme zu integrieren.

 

Authentifizierung

Um die absence.io API nutzen zu können, benötigen Sie einen API-Schlüssel. Um einen zu generieren, gehen Sie bitte zu Ihrem Profil in Ihrem absence.io-Konto und klicken Sie auf die Registerkarte Integrationen und klicken Sie auf die Schaltfläche'API-Schlüssel generieren'. Falls die Schaltfläche nicht angezeigt wird, wende dich bitte an unseren Support Support Kontakt & Kanäle - so erreichst Du uns

 

Der APIKey besteht aus zwei Teilen:

Die Schlüsselkennung (ID), die zur Identifizierung Ihres Schlüssels verwendet wird.
Der aktuelle Schlüssel
Für die Übertragung Ihres APIKey verwenden wir Hawk. Klicken Sie hier, um mehr zu erfahren!

 

Allgemeine Konzepte

Hier finden Sie einen allgemeinen Überblick über unsere API und ihre Funktionen.

 

HTTP Antwortcodes

Klick hier, um mehr über Antwortcodes zu erfahren, die du beim Senden von Anfragen an die API erwarten kannst.

 

Abfragen von Objekten

Alle Anfragen beziehen sich auf ein Format, das hier im Detail zu finden ist.

 

Antwort

Mit Hilfe von Relationen kannst du dem Dienst mitteilen, dass er ID-Eigenschaften für deine jeweiligen Objekte auflösen soll.

Durch das Hinzufügen eines Beziehungsarrays zum Request-Body weist du den Server an, das gesamte Objekt für die ID-Eigenschaft der Haupteinheit zu laden.

Beispielsweise um die assignedToId für eine Eigenschaft namens assignedTo aufzulösen, verwende die folgende Syntax:

 

Anfrage

POST http://localhost:3000/api/v2/absences
{
"Filter": {
"Start": "$lte": "2015-12-20T00:00:00:00.000Z"},
" Ende": "Das ist eine gute Idee: "2015-12-31T00:00:00:00.000Z"}
},
Beziehungen:['assignedToId']
}
 
Antwort
{
" Überspringen": 0,
" Limit": 50,
" Zählen": 50,
" Gesamtzahl": 458,
" Daten": [
{
"_id": "5480402809650202004df75b",
"modifiziert": "2014-12-06T10:04:39.006Z",
"erschaffen": "2014-12-04T11:06:16:16.471Z",
"Start": "2014-12-03T00:00:00:00.00.000Z",
" Ende": "2014-12-08T00:00:00:00.00.000Z",
"assignedToId": "63ec876edf869a0200707ac3",
"assignedTo To": {
"_id": "63ec876edf869a0200707ac3",
" E-Mail": "absence.owner@gmail.com",
" Nachname": " Lebbe",
" Vorname": " Christina",
...
...

}
 

Mehr

Spezifische Informationen und weitere Beispiele zu den einzelnen Einheiten finden Sie hier.

 

Viel Spaß mit unserer Lösung!

Euer Team von absence.io

War dieser Beitrag hilfreich?

Kommentare

0 Kommentare

Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.