Winkstec Perú API

Referencia de la API

Generada desde la especificación OpenAPI 3.1, la misma que usa nuestro servidor.

Descárgala para Postman, Insomnia o un generador de clientes: openapi.json.

GET /v1/ruc/{ruc}

Consultar un RUC

Cobra 1 consulta sólo si el RUC existe en el padrón.

ParámetroEnFormatoEjemplo
ruc *ruta^\d{11}$20131312955
RespuestaDescripción
200Encontrado
400ruc_invalido, lote_invalido, ubigeo_invalido
401clave_faltante, clave_invalida
403lote_no_permitido, ip_no_permitida, cuenta_suspendida
404no_encontrado, ruta_no_existe
429limite_por_segundo, limite_por_minuto, cuota_agotada, demasiados_intentos

Requiere Authorization: Bearer.

POST /v1/ruc/lote

Consultar varios RUC

Planes Pro (50) y Empresa (100). Cobra una consulta por cada RUC encontrado.

RespuestaDescripción
200Resultados en el mismo orden
400ruc_invalido, lote_invalido, ubigeo_invalido
401clave_faltante, clave_invalida
403lote_no_permitido, ip_no_permitida, cuenta_suspendida
429limite_por_segundo, limite_por_minuto, cuota_agotada, demasiados_intentos

Requiere Authorization: Bearer.

GET /v1/ubigeo/{codigo}

Traducir un ubigeo

No gasta consultas.

ParámetroEnFormatoEjemplo
codigo *ruta^\d{6}$150101
RespuestaDescripción
200Lugar
400ruc_invalido, lote_invalido, ubigeo_invalido
401clave_faltante, clave_invalida
404no_encontrado, ruta_no_existe
429limite_por_segundo, limite_por_minuto, cuota_agotada, demasiados_intentos

Requiere Authorization: Bearer.

GET /v1/uso

Tu consumo

Plan, periodo, consultas usadas y créditos. No gasta consultas.

RespuestaDescripción
200Consumo
401clave_faltante, clave_invalida
429limite_por_segundo, limite_por_minuto, cuota_agotada, demasiados_intentos

Requiere Authorization: Bearer.

GET /v1/estado

Estado del padrón

Público, sin clave. Fecha del padrón y número de RUC.

RespuestaDescripción
200Estado

Sin clave.