API-Dokumentation

Integrieren Sie Ihre Systeme mit FireCustos über unsere REST API. Synchronisieren Sie Personaldaten, importieren Sie Feuerwehrleute in großen Mengen und erstellen Sie individuelle Integrationen.

Schnellstart #

Machen Sie Ihren ersten API-Aufruf in drei Schritten.

1. API-Schlüssel erstellen

   Gehen Sie zu Einstellungen → API-Schlüssel im FireCustos Admin-Panel und erstellen Sie einen neuen API-Schlüssel. Kopieren Sie den Schlüssel — er wird nur einmal angezeigt.

2. Erste Anfrage senden

   Verwenden Sie den API-Schlüssel, um Feuerwehrleute in Ihrer Abteilung aufzulisten:

   bash

   Kopieren

   curl -X GET https://app.firecustos.com/api/v1/firefighters \
     -H "Authorization: Bearer fc_your_api_key_here"

3. Antwort ansehen

   Die API gibt JSON mit paginierten Ergebnissen zurück:

   json

   Kopieren

   {
     "data": {
       "items": [
         {
           "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
           "firstName": "Ivan",
           "lastName": "Horvat",
           "phoneNumber": "+385 91 234 5678",
           "email": "ivan.horvat@example.com",
           "dateOfBirth": "1990-05-15T00:00:00Z",
           "invitationStatus": null,
           "userId": null
         }
       ],
       "page": 1,
       "pageSize": 20,
       "totalCount": 1,
       "totalPages": 1,
       "hasPreviousPage": false,
       "hasNextPage": false
     },
     "totalCount": 1
   }

Basis-URL #

Alle API-Endpunkte werden bereitgestellt unter:

https://app.firecustos.com/api/v1/

Konventionen #

Alle Anfrage- und Antwortkörper verwenden JSON. Setzen Sie den Content-Type-Header auf application/json für Anfragen mit Körper. Daten sind im ISO 8601-Format (z.B. 2024-01-15T00:00:00Z). Alle IDs sind UUIDs.