Authentication

Describe the calling API key

Returns the key making the request: its name, environment and the scopes it was granted, plus the company it authorises.

Deliberately unscoped — every integrator's first call, and the cheapest answer to "is my key working". It reveals nothing the caller does not already hold.

A 200 means the key is valid AND the company's plan includes API access. 401 means the key is unknown, revoked or expired; 402 means the plan does not include API access.

get/v1/whoami

Request

  • Base URL: https://api.officina.it
  • URL: https://api.officina.it/v1/whoami
  • Auth: HTTP bearer

Response

The calling key.

objectstring required

always "api_key"

idstring required
namestring required

The label the workshop gave the key.

environment'live' | 'test' required

Matches the token prefix (ofk_live_ / ofk_test_).

scopesstring[] required

Granted scopes, e.g. "customers.read".

Changes

No recorded changes to this operation across all 1 revision of this API.