Quién soy y qué puede hacer esta key

GET/tenant/meProbar

ServidorURL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

GET

/tenant/me

const url = 'http://localhost:3000/v1/tenant/me';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/v1/tenant/me \
  --header 'x-api-key: <x-api-key>'

No requiere scope: lo que devuelve es el contexto de la propia key. Es lo primero que conviene llamar al integrar, para confirmar que el modo (test/live) y los scopes son los que esperas.

Authorizations

ApiKeyAuth

Responses

200

Contexto de la key

application/json

object

tenantId

string

name

string

mode

string

Allowed values: test live

scopes

Array<string>

apiKeyId

string

isPlatform

false en una key de cliente

boolean

Example

{
  "tenantId": "3f1a0c22-9b41-4a77-8f0e-6d2c5b7a1e34",
  "name": "Fintech Ejemplo",
  "mode": "live",
  "scopes": [
    "quotes:write",
    "beneficiaries:read",
    "beneficiaries:write",
    "payments:read",
    "payments:write",
    "treasury:read",
    "events:read",
    "events:write"
  ],
  "apiKeyId": "5c9d2b70-1f44-4c8e-9a3b-2e7f0d5a6b18",
  "isPlatform": false
}