Naar de inhoud

Sleutel en werkruimte

GET /api/v1/me: bij welke werkruimte je sleutel hoort en welke rechten hij heeft.

GET https://leadforge.nl/api/v1/me

Vraagt read

Bij welke werkruimte je sleutel hoort en welke rechten hij heeft. Handig om een nieuwe sleutel te testen en om in je eigen systeem vast te leggen bij welke werkruimte hij hoort.

Authenticatie

Een API-sleutel met het recht read in de header Authorization: Bearer lf_live_.... Zie Authenticatie.

Parameters

Geen.

Antwoord

Dit adres geeft de velden direct terug, zonder data-omhulsel.

Velden

NaamTypeBeschrijving
client.idtekst (uuid)Het id van de werkruimte waar de sleutel bij hoort.
client.nametekst of nullDe naam van de werkruimte.
scopeslijst van tekstDe rechten van de sleutel: read, write of allebei.
StatusCodeWanneer
200De sleutel is geldig.
401unauthorizedGeen, een onbekende of een ingetrokken sleutel.
403forbiddenDe sleutel heeft geen read, of hoort niet bij precies één werkruimte.
429rate_limitedMeer dan 120 verzoeken per minuut.

Voorbeeld

Verzoek
curl https://leadforge.nl/api/v1/me \
  -H "Authorization: Bearer LF_LIVE_SLEUTEL"
JSON Antwoord 200
{
	"client": {
		"id": "<werkruimte-id>",
		"name": "Klant A"
	},
	"scopes": ["read"]
}

Verder lezen