Manual de integración Producto SOAT
Enviado por Will M. Espinoza • 4 de Septiembre de 2022 • Trabajos • 2.703 Palabras (11 Páginas) • 55 Visitas
[pic 1]
[pic 2]
Manual de integración
Producto SOAT
Datos de actualización
Versión del documento: 3.0
Fecha de actualización: 29 de Junio 2022
Índice
1. Crear un token de sesión
2. Obtener puntos de venta
3. Información de placa
4. Obtener marcas de vehiculo
5. Obtener modelos de vehículo
6. Obtener clases por modelo de vehículo
7. Obtener clases
8. Obtener usos por clases
9. Validar vigencia de la placa del vehículo
10. Obtener departamentos
11. Obtener provincias
12. Obtener distritos
13. Obtener tipos de persona
14. Obtener tipos de documento
15. Guardar información de vehículo
16. Obtener numerador de transacción
17. Guardar información de cliente
18. Obtener precio del SOAT
19. Guardar certificado
20. Emisión a crédito
21. Emisión con pasarela de pago
22. Obtener ventas
23. Verificar stock de certificados
24. Obtener constancia SOAT (PDF)
PARÁMETROS GENERALES
URL - APIS:
AMBIENTE | URL |
PRUEBAS | https://servicios.protectasecurity.pe/WSPlataformaDigitalstg/api/ |
PRODUCCIÓN | https://servicios.protectasecurity.pe/WSPlataformaDigital/api/ |
** En el presente documento esto será representado por: {{api}}
URL - ECOMMERCE:
AMBIENTE | URL |
PRUEBAS | https://plataformadigital.protectasecurity.pe/staging/soat/step1 |
PRODUCCIÓN | https://plataformadigital.protectasecurity.pe/ecommerce/soat/step1 |
** En el presente documento esto será representado por: {{url}}
DATOS DE PRUEBA:
DATO | VALOR |
Placa | Cualquier placa que cumpla los requisitos |
Documento | Cualquier tipo y número de documento que cumpla los requisitos |
Usuario ** | ACHIROQUE |
Password ** | 12345678 |
** Para el caso de integración con el ambiente de producción se deben de solicitar credenciales finales.
COLECCION POSTMAN: DESCARGAR
Se adjunta coleccion POSTMAN la cual servirá de ayuda para la verificación de las APIS detalladas en el presente documento, se deben de crear las variables de entorno considerando {{api}} y también {{url}}
APIS DE INTEGRACIÓN
Todos los endpoints están expuestos bajo el concepto REST. Los request en general están diseñados en formato JSON pero deben ser enviados en formato base64 de acuerdo a lo que indique su definición.
A continuación se detalla el flujo que se debe de usar para la integración del producto SOAT.
1. Crear un token de sesión
Para poder consumir todos las endpoints, se debe generar un token de sesión. Este token tiene un tiempo de vigencia y si el token llega a caducar se debe generar uno nuevo.
El token generado se debe enviar a todos los endpoints en el Header de todos los endpoints en los request ejecutados de la siguiente manera:
Request
Method | URL |
POST | {{api}}/user/authenticate |
Tipo | Parámetro | Valor |
POST POST | username password | Nombre del usuario Contraseña del usuario |
{ "username": "ACHIROQUE", "password": "12345678" } |
POST /user/authenticate HTTP/1.1 |
Response
Parámetro | Descripción |
Id | Código del usuario que se autenticó |
Canal | Nombre del canal asociado al usuario |
PuntoVenta | Nombre del punto de venta asociado al canal |
Token | Token a ser usado en la invocación de las demás Apis |
BrokerId | Identificador de agente tipo broker |
IntermediaId | Identificador de agente tipo intermediario |
CambioClave | Indica si el usuario necesita cambiar de clave (0: No / 1: Si) |
2. Obtener puntos de venta
Este endpoint sirve para obtener los puntos de venta asociados al canal del usuario que se ha autenticado. El código de un punto de venta se utiliza para obtener la numeración de certificados que se han distribuido a un punto de venta.
...