Hoe de API gegevens beperkt tot u en uw gekoppelde gebruikers, en hoe sleutelhouders de sessies van een lockee lezen
Elk eindpunt is beperkt tot de gebruikers tot wie u toegang heeft: uzelf, plus iedereen die via een partnerschap aan uw account is gekoppeld. Uw API-token neemt exact dezelfde machtigingen over als uw dashboardaccount, zodat u nooit gegevens ziet die u nog niet in het dashboard kon zien.
Op deze pagina wordt uitgelegd hoe deze toegangsbeperking in de hele API werkt, vooral voor sleutelhouders die de gegevens van hun lockee lezen. Voor de aanvraag- en antwoorddetails van elk afzonderlijk eindpunt raadpleegt u de pagina in de referentie (bijvoorbeeld Lock Sessions).
Sleutelhouders gebruiken dezelfde eindpunten
Sleutelhouders zijn altijd gekoppelde gebruikers. Dat betekent dat er geen aparte sleutelhouder-API is: als sleutelhouder vraagt u de gegevens van uw lockee op via exact dezelfde eindpunten die u voor uw eigen gegevens gebruikt en leest u deze. De resultaten omvatten eenvoudigweg de sessies en apparaten van elke gebruiker die aan u is gekoppeld.
- List Lock Sessions retourneert de sessies van uw lockee naast die van u. Gebruik het veld
ownerIdop elk record om te bepalen van wie de sessie is. - Get Active Lock Session accepteert een
targetUserId-queryparameter, zodat een sleutelhouder kan controleren of het slot van een lockee actief is zonder dat de lockee dit hoeft te melden.
De ownerId van een slotsessie is de gebruiker die het slot draagt. Wanneer u
voor iemand sleutelhouder bent, verschijnen diens sessies in uw resultaten met
diens ownerId, niet die van u.
De ID van een gekoppelde gebruiker zoeken
Eindpunten die op een andere gebruiker inwerken (zoals targetUserId) hebben een numerieke gebruikers-ID nodig. Om de aan u gekoppelde gebruikers en hun ID's te vinden, roept u List Users aan – de respons bevat uzelf plus iedereen die via partnerschappen met u is verbonden, gefilterd op basis van uw accountmachtigingen.
Toegang buiten uw machtigingen
De API maakt nooit gegevens (of zelfs het bestaan van gegevens) buiten uw toegang bekend. Hoe een verzoek wordt afgewezen, hangt af van de manier waarop het doel wordt geïdentificeerd:
| Type verzoek | Buiten uw toegang |
|---|---|
| Een sessie op ID ophalen (bijvoorbeeld Get Lock Session by ID) | Retourneert 404 – de API maakt opzettelijk geen onderscheid tussen "bestaat niet" en "niet van u" |
Een targetUserId doorgeven (bijv. Get Active Lock Session) | Retourneert 403 – het doel is een gebruiker tot wie u geen toegang heeft |
Omdat een zoekopdracht op ID 404 retourneert voor zowel een ontbrekende sessie als
een sessie die van iemand anders is, kunt u deze niet gebruiken om na te gaan of
een bepaalde sessie-ID bestaat. Dit is opzettelijk.