Ir al contenido
SShalom API

Referencia de la API

URL base, autenticación, formato de las respuestas y lista de todos los endpoints de Shalom API.

¿Usas un agente de IA?

Pásale a tu agente docs.shalom-api.lat/llms.txt, que lista cada página de la documentación en Markdown, o agrega .md a la URL de cualquier página para leerla en Markdown.

Shalom API es una API REST con respuestas JSON. Esta página reúne lo común a todos los endpoints y la lista completa; el detalle de cada uno está en su tema.

URL base

https://api.shalom-api.lat

Todas las peticiones usan HTTPS. Cuando hay cuerpo, envíalo en JSON con Content-Type: application/json.

Autenticación

Envía tu API key en el header x-api-key de cada petición, salvo en las rutas /public/*. La copias en el panel, en API Key. Detalles en Autenticación y API keys.

cURL
curl "https://api.shalom-api.lat/validate" \
  -H "x-api-key: TU_API_KEY"

Límites y errores

  • 60 peticiones por minuto por API key. Al superarlo, la API responde 429 con el header retry-after.
  • Cada plan tiene una cuota mensual de operaciones. Solo consumen cuota las llamadas exitosas de los endpoints marcados con Sí en la tabla de abajo.
  • Los errores responden con un código HTTP y un cuerpo JSON con el campo error. Lista completa en Errores y límites.

Shalom Pro

Los endpoints marcados con Sí en la columna Shalom Pro operan sobre tu cuenta de Shalom Pro: necesitan una instancia con la sesión iniciada y su instanceId. Se llaman con tu misma API key.

Todos los endpoints

MétodoRutaQué haceCuotaShalom Pro
POST/trackRastrear una guíaSíNo
POST/track/batchRastrear hasta 50 guíasSí, 1 por llamadaNo
GET/track/by-oseResolver un ose_id a guía y códigoSíOpcional
GET/track/voucherTicket oficial en PDF o imagenSíSí
GET/track/labelRótulo en PDFSíSí
GET/agenciesListar agenciasSíNo
GET/agencies/searchBuscar agencias y ordenar por cercaníaSíNo
GET/public/agenciesListado público, sin API keyNoNo
GET/public/agencies/searchBúsqueda pública, sin API keyNoNo
GET/locations/departmentsDepartamentos con agenciasSíNo
GET/locations/departments/{depId}/provincesProvincias de un departamentoSíNo
GET/locations/departments/{depId}/provinces/{provId}/districtsDistritos de una provinciaSíNo
POST/account/quoteCotizar un envíoSíOpcional (recomendado)
GET/account/dni/{dni}Consultar un DNISíNo
GET/account/productsCatálogo de contenidosNoNo
POST/account/registerCrear una guíaSíSí
POST/account/register-bulkCrear guías en loteSí, 1 por llamadaSí
POST/account/get-userPerfil del remitenteSíSí
POST/account/person/searchBuscar una persona registradaSíSí
POST/account/pending-shipmentsEnvíos pendientesSíSí
DELETE/account/pending-shipmentsAnular un envío pendienteSíSí
GET/account/tracking-listEnvíos en tránsitoSíSí
GET/account/historyHistorial de entregadosSíSí
GET/account/vouchersComprobantesSíSí
POST/shipments/pickup-codeCambiar la clave de recojoSíSí
POST/shipments/self-managementIniciar una autogestión (envía el código)NoSí
POST/shipments/self-management/confirmConfirmar la autogestiónSíSí
GET/shipments/self-managementHistorial de autogestionesNoSí
GET/shipments/home-delivery/ubigeoUbigeo para reparto a domicilioNoSí
POST/instancesCrear una instanciaNoNo
GET/instancesListar instanciasNoNo
DELETE/instancesEliminar una instanciaNoSí (instanceId)
POST/instances/statusEstado de la sesiónNoSí
POST/instances/loginIniciar sesión en Shalom ProNoSí
POST/instances/logoutCerrar sesión en Shalom ProNoSí
PUT/webhooksConfigurar el webhookNoNo
GET/webhooksConsultar el webhookNoNo
DELETE/webhooksEliminar el webhookNoNo
GET/webhooks/deliveriesHistorial de entregasNoNo
POST/tracking/subscriptionsSuscribir una guíaNoNo
GET/tracking/subscriptionsListar suscripcionesNoNo
DELETE/tracking/subscriptionsCancelar una suscripciónNoNo
GET/validateValidar la API key y ver el consumoNoNo

Por tema