Vista General

Bienvenido a la referencia de la API Sheriff Perú. Aquí encontrarás la documentación detallada de todos los endpoints disponibles.

Requisitos Previos

Para utilizar la API de Sheriff Perú necesitas:

1. Cuenta activa de Sheriff Perú: Debes tener una cuenta registrada y activa en Sheriff Perú.
2. Autenticación: Todas las consultas a los endpoints requieren autenticación mediante tokens JWT.

👉 Consulta la guía de autenticación para obtener tus credenciales y generar tokens de acceso.

Estructura General de la Respuesta

Las respuestas exitosas de la API (código 200 OK) están envueltas en un objeto JSON con la siguiente estructura:

{
  "statusCode": 200,
  "data": {
    // ... El contenido específico del endpoint va aquí
  }
}

• statusCode: Un número que representa el código de estado HTTP. Para respuestas exitosas, siempre será 200.
• data: Un objeto que contiene la información solicitada, específica para cada endpoint.

Estados de Carga (v2)

En la v2, el resumen de perfil indica además el estado de la carga: estado y subhelpers_fallidos a nivel raíz, y cada sección envuelta en { statusCode, data } con un código propio de Sheriff:

Código	Significado
SH10	Éxito — data completa
SH11	Éxito parcial — data con lo que cargó
SH20	En proceso — data: {}
SH30	No contratado en el plan — data: {}
SH50	Fuente caída / fallo de carga — data: {}

👉 El catálogo completo (incluidos los códigos reservados SH40/SH41/SH51) y la semántica de cada estado están en Estados de Carga.

Montos

Todos los montos y valores monetarios devueltos por la API están expresados en Soles (PEN).