Waarom staat er geen omgevings-id in de andere endpoints?

Omdat de omgeving uit de sleutel volgt. Daardoor kan een sleutel nooit gegevens van een andere omgeving teruggeven, ook niet als iemand met de URL knoeit.

Kan ik hiermee controleren of mijn rechten kloppen?

Ja. Het veld scopes geeft precies terug wat deze sleutel mag lezen. Staat er iets niet bij dat je nodig hebt, dan moet de beheerder de rechten van de sleutel aanpassen.

Wie ben ik

GET https://scintillating-wolf-799.eu-west-1.convex.site/v1/me

Vertelt bij welke omgeving deze sleutel hoort en wat hij mag lezen. Handig als eerste aanroep om te controleren of een koppeling goed staat.

Werkt met elke geldige sleutel, ongeacht de rechten.

Gebruik dit endpoint als eerste controle bij het inrichten van een koppeling. Het antwoord vertelt bij welke omgeving je sleutel hoort en wat hij mag lezen, dus je weet meteen of je de juiste sleutel te pakken hebt en of de rechten kloppen.

Er is geen recht voor nodig: elke geldige sleutel krijgt antwoord, ook een die verder niets mag. Dat maakt het geschikt als test bij het opstarten van je toepassing. Krijg je hier een 401, dan is de sleutel zelf het probleem en hoef je niet verder te zoeken in je code.

De omgeving volgt uit de sleutel en niet uit een parameter. Bouw je een toepassing die meerdere omgevingen bedient, dan is dit het endpoint waarmee je per sleutel vaststelt welke omgeving je voor je hebt.

Voorbeeld

curl "https://scintillating-wolf-799.eu-west-1.convex.site/v1/me" \
  -H "Authorization: Bearer <je sleutel>"

Antwoord

{
  "tenant": {
    "id": "pd7…",
    "slug": "voorbeeld",
    "name": "Voorbeeld Academie"
  },
  "scopes": [
    "finance:read",
    "catalog:read"
  ]
}

Velden

Veld	Type	Betekenis
`tenant.id`	string	Vaste verwijzing naar de omgeving.
`tenant.slug`	string	Het korte adres van de omgeving.
`tenant.name`	string	Naam van de omgeving.
`scopes`	lijst met strings	Wat deze sleutel mag lezen. Alles daarbuiten geeft insufficient_scope.

Veelgestelde vragen

Waarom staat er geen omgevings-id in de andere endpoints?: Omdat de omgeving uit de sleutel volgt. Daardoor kan een sleutel nooit gegevens van een andere omgeving teruggeven, ook niet als iemand met de URL knoeit.
Kan ik hiermee controleren of mijn rechten kloppen?: Ja. Het veld scopes geeft precies terug wat deze sleutel mag lezen. Staat er iets niet bij dat je nodig hebt, dan moet de beheerder de rechten van de sleutel aanpassen.

Hierna nodig

Abonnementen (GET /subscriptions)
Leden (GET /members)
Producten (GET /products)

Werkt je aanroep niet zoals verwacht, kijk dan bij de foutcodes en wat ze betekenen. Heb je nog geen sleutel, dan legt de kennisbank uit hoe je er een aanmaakt.