URL & Eindpunten
URL's
| Omgeving | URL |
|---|---|
| Productie | https://api.caught.nu/v1 |
Beschikbare Eindpunten
Dit is een lijst van de beschikbare eindpunten van de Caught API met hun doel.
| Type | Naam van het endpoint | Doel | Details |
|---|---|---|---|
| GET | /applications | Bekijk alle beschikbare Applicaties in het Caught-platform onder je account | Details |
| GET | /applications/{{applicationId}} | Bekijk een specifieke Applicatie van je Caught-account - de Applicatie-ID kan gekopieerd worden uit de URL bij het bewerken in Caught | Details |
| GET | /locations/{{locationId}} | Bekijk een specifieke rollout (Locatie) in Caught onder je account op basis van de ID | Details |
| GET | /locations?applicationId={{applicationId}} | Bekijk alle rollouts (Locaties) voor een specifieke Applicatie in Caught onder je account | Details |
| GET | /groups/{{groupId}} | Bekijk een specifieke Groep (boeking/gebruiker) in Caught onder je account op basis van de ID | Details |
| GET | /groups?locationId={{locationId}} | Bekijk alle niet-gearchiveerde Groepen (boekingen/gebruikers) onder je account voor een specifieke rollout (Locatie) op basis van de Locatie-ID. Voeg &archived=true toe om gearchiveerde Groepen te bekijken (tot 6 maanden terug) | Details |
| GET | /teams/{{teamId}} | Bekijk Team-informatie van een specifiek Team op basis van de ID | Details |
| GET | /teams?groupId={{groupId}} | Bekijk alle Team-informatie van een specifieke Groep | Details |
| GET | /photos?groupId={{locationId}} | Bekijk een specifieke rollout (Locatie) in Caught onder je account | Details |
| POST | /groups?locationId={{locationId}} | Voeg een Groep (gebruiker/boeking) toe voor een specifieke rollout (Locatie) op basis van de Locatie-ID (Enkelvoudig) | Details |
| POST | /groups?locationId={{locationId}} | Voeg meerdere Groepen (gebruikers/boekingen) toe voor een specifieke rollout (Locatie) op basis van de Locatie-ID. Hetzelfde endpoint als voor een enkele Groep, maar met een andere payload. Zie details voor een voorbeeld | Details |
| POST | /groups?locationId={{locationId}} | Voeg toe/verwijder meerdere Groepen (gebruikers/boekingen) voor een specifieke rollout (Locatie) op basis van de Locatie-ID. Hetzelfde endpoint als voor een enkele Groep, naar met een andere payload, inclusief te verwijderen Groep-IDs. Kan ook gebruikt worden om alleen te verwijderen | Details |
| POST | /teams?groupId={{groupId}} | Voeg een Team toe aan een specifieke Groep op basis van de Groep-ID | Details |
| POST | /teams?groupId={{groupId}} | Voeg meerdere Teams in batch toe voor een specifieke Groep-ID. Hetzelfde endpoint als voor een enkel Team, maar met een payload voor batch-info (Naam prefix, PIN-code per Team en generateAccessCode) | Details |
| DELETE | /groups/{{groupId}} | Verwijder een enkele Groep (gebruiker/boeking) op basis van de Groep-ID | Details |
| DELETE | /groups | Verwijder meerdere Groepen (gebruikers/boekingen) op basis van hun Groep-ID. Geef een Array van Groep-IDs op in de payload. Zie details voor een voorbeeld | Details |
Postman Documentatie
Voor meer gedetailleerde informatie over elk van de eindpunten kun je de meer gedetailleerde Postman Documentatie met codevoorbeelden voor jouw programmeertaal bekijken.
