Zum Hauptinhalt springen

AVAILIO API – Hilfe für Integratoren - Wissensdatenbank / AVAILIO / AVAILIO API - Fairgate DeskPro

AVAILIO API – Hilfe für Integratoren

Zielgruppe: IT‑Dienstleister und Hardware‑Hersteller (z. B. Türsteuerungen, Smart‑Lighting, HVAC), die Live‑Buchungen aus Fairgate in ihre Systeme integrieren möchten.


Inhaltsverzeichnis

  1. Service buchen

  2. API-Zugang einrichten

  3. Buchungen abrufen


1  Service buchen

1.1  Voraussetzungen

1.2  Buchungs‑Workflow

  1. Melden Sie sich in der Fairgate‑Weboberfläche an.

  2. Öffnen Sie das Menü Verwaltung › Module & Services.

  3. Klicken Sie in der Kachel AVAILIO REST‑API (v1.0) auf Jetzt buchen.

  4. Schliessen Sie den Bestätigungsdialog mit OK ab.

  5. Nach wenigen Sekunden erscheint eine Erfolgsmeldung – das Modul ist nun einsatzbereit.



2  API-Zugang einrichten

2.1  Access‑Key & Token‑Flow

Nach erfolgreicher Buchung finden Sie den neuen Reiter FSA Service › AVAILIO API unter Einstellungen.


  1. API aktivieren – setzen Sie den Schalter auf Aktiviert.

  2. Access‑Key generieren – klicken Sie auf Generieren

  3. Kopieren Sie

    • OID (Organisation‑ID)

    • Access‑Key

  4. Access‑Token abrufen

    # Authorize
    curl -X POST \
      -H "Content-Type: application/json" \
      -d '{"access_key":"{{access_key}}"}' \
      https://fsa.fairgate.ch/fsa/v1.1/auth/create/{{oid}}/token

    → Die Antwort enthält access_token, refresh_token.

  5. Verwenden Sie das Token – jeden weiteren Request senden Sie mit
    Authorization: Bearer {{access_token}}.

  6. Erneuern Sie das Token vor Ablauf:
    POST /fsa/v1.1/auth/refresh/{{oid}}/token.



3  Buchungen abrufen

3.1  Live‑Bookings‑Endpoint

GET /fsa/v1.0/booking/{{oid}}/reservations

Ausser dem Pfadparameter {{oid}} sind keine weiteren Parameter erforderlich. Der Endpoint liefert sämtliche aktuellen sowie zukünftigen Reservationen Ihrer Organisation.

3.2  Beispiel‑Request

curl -H "Authorization: Bearer {{access_token}}" \
  "https://fsa.fairgate.ch/fsa/v1.0/booking/{{oid}}/reservations"

Weiterführende Ressourcen



Hilfreich Nicht hilfreich