Hämta nyckelns uppgifter

GET/api/v1

Vilken arbetsyta nyckeln gäller, vem den agerar som och vad den får göra. Bra för att testa kopplingen.

Behörighet

Alla giltiga nycklar.

Svar

200 Nyckelns uppgifter.

api_versionstringkrävs
workspaceobjectkrävs
workspace.idstringkrävs
workspace.namestringkrävs
keyobjectkrävs
key.idstringkrävs
key.namestringkrävs
key.prefixstringkrävs
key.scopesarray<string>krävs
acting_asobjectkrävs: Personen som nyckeln agerar som, och hens roll i arbetsytan just nu. För Qronas systemnyckel är id null.
acting_as.idstring | nullkrävs
acting_as.namestring | nullkrävs
acting_as.rolestringkrävs: owneradmineditorviewer

Fel

401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
429: rate_limited
500: internal_error

Anrop

curl 'https://newsletter.qrona.se/api/v1' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY"

Svar 200

{
  "api_version": "1",
  "workspace": {
    "id": "0b8f…",
    "name": "Exempel AB"
  },
  "key": {
    "id": "5d1e…",
    "name": "Webbutiken (WooCommerce)",
    "prefix": "qn_live_AbCd",
    "scopes": [
      "contacts:read",
      "contacts:write",
      "fields:read",
      "lists:read"
    ]
  },
  "acting_as": {
    "id": "7a2c…",
    "name": "Anna Svensson",
    "role": "admin"
  }
}