Saltar al contenido
Docs

Referencia

Verificar la llave

GET/v1/partner/pingping:read

Verifica que tu llave API funciona y qué permisos tiene

Propósito

La primera llamada que debes hacer al integrar. Confirma que tu llave es válida y te muestra con qué permisos (scopes) cuenta, sin tocar ningún dato.

Cuándo usarlo

  • Al iniciar la integración, para confirmar que la llave está bien configurada.
  • Después de rotar la llave, para verificar que la nueva funciona.
  • En health checks periódicos de tu sistema.

Ejemplo con curl

curl -H "x-api-key: slan_…" https://api.slan.mx/v1/partner/ping

Nota

En local, emite una llave con POST /v1/partner/sandbox/api-key (esa ruta no existe en producción).

Respuesta 200

La llave es válida y estos son sus scopes

  • keyPrefixstring

    Prefijo de la llave con la que llamaste; sirve para saber CUÁL estás usando.

    Ejemplo: "slan_9fQ2xL"

  • okboolean

    Siempre true: llegar aquí ya significa que la llave es válida.

    Ejemplo: true

  • scopesarray de string

    Scopes efectivos, ordenados. Un endpoint fuera de esta lista responde 403.

    Ejemplo

    ["api-keys:rotate","me:read","payment-links:read","payment-links:write","ping:read","users:read","users:write","wallets:read","wallets:write"]

Errores

EstadoCódigosCuándo
401sin codeSin `x-api-key`, o la llave no existe, expiró o fue revocada Sin x-api-key válida
403sin codeLa llave no tiene el scope ping:read
429RATE_LIMITEDLimite de uso: 120 por minuto por credencial. Respeta la cabecera `Retry-After`.