Die französische Fassung dieses Artikels wurde seit der Übersetzung aktualisiert. Französische Fassung lesen
Verbinden Sie Ihr Tool über die API
Ihre Software steht nicht in der Liste? Erzeugen Sie ein Import-Token und lassen Sie Ihr eigenes Tool Ihre Unterkünfte, Buchungen und Einsätze senden, mit der eigenen Quelle.
Das Video zu dieser Anleitung folgt in Kürze.
Die eigene Quelle (API) speist The Big One aus jedem Tool: Ihrer hauseigenen Software, einer automatisierten Tabelle, einem Tool, das wir nicht kennen. Ihr Tool sendet Unterkünfte, Buchungen, Einsätze und Dienstplannamen mit einer einfachen Anfrage. Dieser Artikel zeigt Ihnen, was Sie vorbereiten und was Sie der Person weitergeben, die die Anbindung vornimmt. Rechnen Sie mit 5 Minuten auf Ihrer Seite.
Ihre Software steht auf der Seite Integrationen? Verknüpfen Sie sie lieber ohne Entwicklung: Verbinden Sie Ihre Verwaltungssoftware.
Was die Verbindung synchronisiert
| Angabe | Richtung | Bemerkung |
|---|---|---|
| Unterkünfte | Von Ihrem Tool zu The Big One | Eine Unterkunft, die in einer Sendung fehlt, wird nie gelöscht |
| Buchungen | Von Ihrem Tool zu The Big One | Storniert nur, wenn Ihr Tool einen vollständigen Zeitraum meldet |
| Einsätze | Von Ihrem Tool zu The Big One | Ein begonnener, abgeschlossener oder bestätigter Einsatz wird nie überschrieben |
| Dienstplannamen | Von Ihrem Tool zu The Big One | Werden bestehenden Konten zugeordnet; es wird kein Konto angelegt |
Bevor Sie beginnen
- Sie sind Administrator: Die Seite Integrationen ist dem Administrator vorbehalten.
- Eine Person kann ein kleines Programm schreiben, das Daten sendet: Ihr Entwickler oder der Anbieter Ihres Tools.
- Jede Unterkunft, jede Buchung und jeder Einsatz Ihres Tools hat eine Kennung, die sich nicht ändert. Sie verhindert Dubletten.
Das Import-Token erzeugen
Schritt für Schritt
- 1
Öffnen Sie Einstellungen › Workflows & Integrationen › Integrationen.
- 2
Klicken Sie oben auf der Seite auf den Filter „Entwickler“. Dort befindet sich die Karte „Eigene Quelle (API)“.
- 3
Klicken Sie auf Token erzeugen. Das Fenster „Ihr Import-Token“ öffnet sich.
- 4
Klicken Sie auf Token kopieren. Die Meldung „Token kopiert.“ erscheint.
- 5
Bewahren Sie das Token an einem sicheren Ort auf und schließen Sie das Fenster. Die Karte trägt den Hinweis „Token aktiv“.
Die Angaben an Ihren Entwickler weitergeben
Schritt für Schritt
- 1
Klicken Sie auf der Karte neben „Zieladresse:“ auf Kopieren. Die Meldung „Adresse kopiert.“ erscheint.
- 2
Klicken Sie auf Dokumentation ansehen. Die Seite beschreibt die Adresse, die Kopfzeilen, ein vollständiges Beispiel, die Importregeln und die Grenzen.
- 3
Senden Sie Ihrem Entwickler die Zieladresse, den Link zur Dokumentation und, über einen sicheren Weg, das Token.
Die Regeln, die man kennen sollte, bevor man das Programm schreibt:
| Regel | Was sie bedeutet |
|---|---|
| Eine Kennung je Element | Jedes Element wird an seiner Kennung erkannt: Denselben Inhalt erneut zu senden, erzeugt keine Dublette |
| Unterkunft fehlt in einer Sendung | Sie wird nie gelöscht: Es zählt nur der gesendete Wert „aktiv“ |
| Wäsche der Unterkunft | Bei jeder Sendung wird der Wäscheteil des Profils vollständig ersetzt: Eine Eingabe von Hand wird überschrieben |
| Einsatz bereits begonnen | Er wird nie überschrieben: Nur seine leeren Felder werden ergänzt |
Die Importe prüfen
Schritt für Schritt
- 1
Lesen Sie auf der Karte „Eigene Quelle (API)“ die Zeile „Letzter Import:“. Sie nennt das Datum der letzten empfangenen Sendung.
- 2
Klappen Sie „Letzte 30 Importe“ auf. Jede Zeile zählt je Datenart die angelegten, aktualisierten und beibehaltenen Elemente.
- 3
Eine Zeile meldet Fehler? Klappen Sie sie auf, um die Einzelheiten zu lesen, und geben Sie sie an Ihren Entwickler weiter.
Das Token widerrufen
Das tun Sie, wenn das Token weitergegeben wurde oder wenn Sie das Tool wechseln.
Schritt für Schritt
- 1
Klicken Sie auf der Karte auf Widerrufen. Das Fenster „Token widerrufen?“ öffnet sich.
- 2
Klicken Sie auf Token widerrufen. Die Meldung „Token widerrufen: Künftige Aufrufe werden abgelehnt.“ erscheint.
- 3
Um Ihr Tool wieder anzubinden, klicken Sie erneut auf Token erzeugen und geben Sie das neue Token Ihrem Entwickler.
Häufige Fragen
Braucht man einen Entwickler?
Ja. Die eigene Quelle erwartet Daten, die ein Programm sendet. Ohne Entwickler verknüpfen Sie eine Software der Seite Integrationen oder einen iCal-Link.
Lässt sich eine über die API importierte Unterkunft mit einem Inserat einer anderen Integration verknüpfen?
Nein. Ihr Tool findet sie bei jeder Sendung über ihre Kennung: Sie lässt sich nicht mit einem Inserat einer anderen Integration verknüpfen.
Kann mein Tool benachrichtigt werden, wenn ein Einsatz abgeschlossen ist?
Ja. Unter dem Filter „Entwickler“ lässt sich über die Karte „Entwicklerzugang“ eine Adresse hinzufügen, die benachrichtigt wird, wenn ein Einsatz zugewiesen, begonnen, abgeschlossen oder bestätigt wird.
Was passiert, wenn ich ein neues Token erzeuge?
Das alte wird widerrufen: Sendungen, die es nutzen, werden abgelehnt. Geben Sie das neue Token Ihrem Entwickler.
Legt der Import die Konten der Reinigungskräfte an?
Nein. Ein Import legt kein Konto an: Namen ohne Entsprechung werden an Ihr Tool zurückgemeldet, damit Sie die Person einladen.