Saltar al contenido principal

Guía de Integración

Aprende cómo integrar Sheriff API en tu aplicación en minutos.

Requisitos Previos​

Para integrar Sheriff API asegúrate de tener:

  1. Una cuenta activa en Sheriff.
  2. Tus credenciales de API (accessKey y accessSecret).

👉 ¿Cómo obtener mis credenciales?

Obtener Credenciales​

Para obtener tus credenciales de API, debes dirigirte a la plataforma web de Sheriff e iniciar sesión con tu cuenta. Dirigete a la sección de API Credentials y genera un nuevo par de credenciales. Para más información, dirígete a la sección de API Credentials.

  • accessKey: Tu llave pública de API (ej: ak_132145...)
  • accessSecret: Tu llave secreta (ej: sk_xyz789...)

Configuración de Entorno​

Por seguridad, nunca escribas tus credenciales directamente en el código fuente. Utiliza variables de entorno.

# Archivo .env
SHERIFF_API_URL=https://api-public.thesheriff.pe/v1
SHERIFF_ACCESS_KEY=ak_132145...
SHERIFF_ACCESS_SECRET=sk_xyz789...
Seguridad

El accessSecret permite generar tokens y acceder a data sensible. No lo compartas ni lo subas a repositorios públicos (GitHub, GitLab, etc.).

Flujo de Autenticación​

Sheriff utiliza un esquema de autenticación Bearer Token con rotación:

  1. Intercambio de credenciales: Envías tu Access/Secret para obtener un token JWT temporal.
  2. Consultas: Usas el token en el header Authorization para hacer requests a la API.

Importante: Ten en cuenta que la generación de tokens está limitada por razones de seguridad. Evita solicitar un token en cada request, cachea el token en tu aplicación y renueva con /refrescar-token cuando esté próximo a expirar.

Nota

Para más detalles técnicos sobre este flujo, revisa la documentación completa en la sección de Autenticación.

¿Qué sigue después de autenticarse?​

Una vez autenticado puedes hacer requests a los endpoints de la API. Consulta la sección de documentación técnica en Plataforma para ver la lista completa de endpoints y sus esquemas.

Próximos Pasos​