Guía de integración

En esta guía mostraremos el camino completo para los integradores de como hacer su integración usando los recursos y los flujos explicados y definidos mas adelante en la documentación para que se puedan mover mas ágilmente por ella.

Como se puede ver todo el contenido está definido en Login, Seguros, Presupuestos y Descarga de ficheros, en donde tenemos definidos flujos y llamadas a la API. Lo primero que tenemos que saber es que para todas las llamadas que tenemos definidas en nuestra API tendremos que especificar en la urls el origen desde el que estamos queriendo comunicarnos. En este caso para los integradores siempre será el mismo: "INT". Para el detalle de como hacer esa llamada ve a la sección de Login de la documentación.

Nuestra API lo que te permite hacer entre otras muchas cosas es crear y gestionar presupuestos, contrataciones y ficheros. Por ejemplo, para los seguros tenemos el flujo completo de contratación en la sección de Contratación. Ese flujo se compone de varias llamadas. Lo mas normal es que la aplicación que va a consumir nuestra API tenga un listado de productos o pólizas a contratar. Estas pólizas vendrán descritas en la respuesta de la llamada comentada anteriormente de Login, es decir, una vez logeado tendrás acceso a contratar ciertas pólizas y con esto ya tendríamos un listado de pólizas que los integradores podrán enseñar en sus aplicaciones.

Las pólizas pueden tener a parte de su detalle unos documentos adjuntos, para todo lo que contiene el detalle de la póliza puedes ver la llamada en getPolicy y para el listado de documentos de esa póliza, usando su numero identificador puedes conseguir sus documentos tal como se describe en Documentos. Las pólizas también tienen ampliaciones que cubren ciertas características que una póliza normal no cubre, en el detalle de la póliza estarían listadas pero existen varios tipos y características específicas a tener en cuenta de como funcionan las ampliaciones, para entrar en mas detalle ve a la sección Ampliaciones.

Una vez el usuario ha escogido la póliza a contratar junto con su posible ampliación y demás atributos tendrás que conocer el precio, para ello tendrás que hacer una llamada a nuestra API, la llamada de tarificación de Pricing. Y más tarde, después de haber rellenado ya todos los datos necesarios del usuario a través de un formulario se hará la llamada para hacer ya la contratación final a PostInsurance.

Además de estas llamadas iniciales o básicas de Pólizas también hay modificaciones y anulaciones de lo contratado y también podemos listar lo que ya hemos contratado anteriormente incluso añadiendo filtrado en su búsqueda.

Una vez ya tienen los usuarios un contrato se pueden visualizar los seguros contratados con getInsurances y descargar los ficheros certificados, hay varios tipos, puedes ver como conseguirlos en el apartado de Certificados.

Para los presupuestos podemos crear nuevos presupuestos llamando a la API y también listar los ya creados o recoger el detalle de uno en especial, también obviamente tenemos la opción de borrado.

Con esto tendrías una idea general de como navegar por la documentación y lo que serían las herramientas básicas de nuestra API para poder llevar a cabo la integración.