URL & Eindpunten
URL's
| Omgeving | URL |
|---|---|
| Test | https://test.api.caught.nu/v1 |
| 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 eindpunt | 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 met behulp 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 met behulp van de ID | Details |
| GET | /groups?locationId={{locationId}} | Bekijk alle niet-archiefgroepen (boekingen/gebruikers) onder je account voor een specifieke rollout (Locatie) met behulp van de locatie-ID. Voeg &archived=true toe om gearchiveerde groepen te bekijken (tot 6 maanden terug) | 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) met behulp van de locatie-ID. (Enkelvoudig) | Details |
| POST | /groups?locationId={{locationId}} | Voeg meerdere groepen (gebruikers/boekingen) toe voor een specifieke rollout (Locatie) met behulp van de locatie-ID. Hetzelfde eindpunt als voor een enkele groep, maar met een andere payload. Zie details voor een voorbeeld. | Details |
| POST | /groups?locationId={{locationId}} | Voeg/verwijder meerdere groepen (gebruikers/boekingen) toe voor een specifieke rollout (Locatie) met behulp van de locatie-ID. Hetzelfde eindpunt als voor een enkele groep, maar met een andere payload, inclusief groep-ID's om te verwijderen. Zie details voor een voorbeeld. Kan ook alleen voor verwijderen worden gebruikt, maar een locatie-ID moet worden opgegeven. | Details |
| DELETE | /groups/{{groupId}} | Verwijder een enkele groep (gebruiker/boeking) met behulp van de groep-ID. | Details |
| DELETE | /groups | Verwijder meerdere groepen (gebruikers/boekingen) met behulp van hun groep-ID. Geef een array van groep-ID's in de payload op. 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.
