ByDomuDevelopers
Create key

Información de la API key

GEThttps://api.bydomu.com/v1/me

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Devuelve la clave actual, la organización y los scopes. Sirve para comprobar que la clave es válida. rateLimit es un valor fijo histórico: el límite real de la clave llega en X-RateLimit-Limit.

Permission
Any valid key
Keys
Publishable or secret

Headers

X-API-Keystringrequired
Your publishable or secret key.

Responses

200La clave, su organización y sus scopes
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl "https://api.bydomu.com/v1/me" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/me", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/me",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": {
    "apiKeyId": "clx1key001",
    "organization": {
      "id": "clx1org001",
      "plan": "BUSINESS",
      "isActive": true
    },
    "rateLimit": {
      "limit": 1000,
      "window": "1 minute"
    },
    "scopes": [
      "portal:read"
    ],
    "legacyFullAccess": false
  }
}

The key goes in the BYDOMU_API_KEY variable. The example data belongs to no agency.