En este documento se van va a realizar un ciclo completo por todas las peticiones. Este ciclo irá, desde el método de acceso a la API, hasta la modificación de un campo de alguna de las entidades de Apiges Pro.
| Info |
|---|
Se recomienda tener abierto el documento Peticiones, para más información y ejemplos acerca de cada una de las peticiones. |
...
En primer lugar, debemos autenticarnos para poder utilizar la API. Para ello, vamos a realizar la petición [GET] /login con usuario y contraseña facilitados por Grupo10 Grupo 10.
Al realizar esta petición, obtendremos un token de acceso válido que deberemos utilizar en el resto de peticiones.
| Note |
|---|
Esta acción se debe realizar diariamente, para asegurar tener siempre activo un token de acceso |
En caso de utilizar Swagger para las peticiones, el token se debe registrar en la parte de autenticación:
- Pulsamos en el botón “Authorize”, situado en la parte superior izquierda:
...
2.- Introducimos en el cuadro de texto Bearer seguido del token que hemos obtenido y pulsamos “Authorize”:
...
| Note |
|---|
No olvidar Bearer en el cuadro de texto ya que identifica el tipo de autenticación a utilizar |
Una vez autenticados, vamos a comenzar con las peticiones de Contactos.
Podemos empezar buscando un contacto en concreto en base a sus características (apellidos, código, tipo de contacto…) . Para ello, realizaremos una petición a [POST] /contactos/search
. Esta petición
, nos devolverá una lista de contactos que cumplen con los filtros de búsqueda.
Si, en esta lista, el contacto no existe, podemos dar de alta en el sistema un nuevo contacto nuevo utilizando la petición [POST] /contactos.
Esta petición nos devolverá el identificador del contacto nuevo
óo, en caso de existir, el identificador del contacto existente.
Una vez tenemos el identificador del contacto, podemos realizar la petición [GET] /contactos/{id}
para obtener la información acerca del contacto.
Una vez localizado el contactoéste, podemos realizar peticiones sobre sus domicilios:
Realizamos la petición [GET] /contactos/{id}/domicilios
para obtener los domicilios asociados a ese contacto. Si no tiene domicilios, podemos crear uno nuevo para ese contacto [POST] /contactos/{id}/domicilios.
. Esta petición nos devolverá el identificador del domicilio creado. También , podemos modificar información de un domicilio en concreto, pasando el identificador del domicilio que queremos modificar cambiar y el identificador del contacto al que pertenece: [PUT] /contactos/{id}/domicilios/{idDomicilio}.
Además, podemos realizar peticiones sobre los titulares asociados a ese contacto:
Realizamos la petición [GET] /contactos/{id}/titulares
para obtener los titulares asociados a ese cliente.Si no tiene titulares, podemos crear un titular nuevo para ese contacto con la petición [POST] /contactos/{id}/titulares
. Esta petición nos devolverá el identificador del titular creado o existente.
Una vez claro acerca de que qué podemos hacer el bloque de contactos, vamos a pasar al bloque de Expedientes.
...
En caso de no existir el expediente, podemos crear uno nuevo asociado a un contacto con la llamada [POST] /expedientes.
Esta petición nos devolverá el identificador del expediente que acabamos de crear
óo, en caso de existir, el identificador del expediente existente.
Una vez tenemos el identificador del expediente, podemos realizar la petición [GET] /expedientes/{id}
para obtener la información acerca del
expedientemismo.
Una vez localizado el expedienteA continuación, podemos realizar modificaciones sobre el mismo (darlo de baja, cambiar su denominación…) con la petición [PUT] /expedientes/{id}
Además, podemos realizar peticiones sobre los titulares asociados a ese expediente:
Realizamos la petición [GET] /expedientes/{id}/titulares
para obtener los titulares asociados a ese expediente.Si no tiene titulares, podemos crear un titular nuevo para ese expediente con la petición [POST] /expedientes/{id}/titulares
. Esta petición nos devolverá el identificador del titular creado o existente.
Por último, sería interesante poder realizar una búsqueda de los actos que corresponden a una fecha en concreto, o bien entre dos rangos de fechas. Para ello, utilizamos la petición [POST] /expedientes/actos/search,
que nos devolverá un listado con todos los actos que cumplen con los filtros de búsqueda.