Page Comparison

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.

Image RemovedImage Added

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.

Status
colour Blue title 1

Al realizar esta petición, obtendremos un token de acceso válido que deberemos utilizar en el resto de peticiones.

Status
colour Blue title 2

Note
Esta acción se debe realizar diariamente, para asegurar tener siempre activo un token de acceso

...

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

Status
colour Blue title 3

. Esta petición , nos devolverá una lista de contactos que cumplen con los filtros de búsqueda.

Status
colour Blue title 4

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.

Status
colour Blue title 5

Esta petición nos devolverá el identificador del contacto nuevo óo, en caso de existir, el identificador del contacto existente.

Status
colour Blue title 6

Una vez tenemos el identificador del contacto, podemos realizar la petición [GET] /contactos/{id}

Status
colour Blue title 7

para obtener la información acerca del contacto.

Status
colour Blue title 8

Una vez localizado el contactoéste, podemos realizar peticiones sobre sus domicilios:

• Realizamos la petición [GET] /contactos/{id}/domicilios

  Status
  colour Blue title 9

  para obtener los domicilios asociados a ese contacto.

  Status
  colour Blue title 10

• Si no tiene domicilios, podemos crear uno nuevo para ese contacto [POST] /contactos/{id}/domicilios.

  Status
  colour Blue title 11

  . Esta petición nos devolverá el identificador del domicilio creado.

  Status
  colour Blue title 12

• 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}.

  Status
  colour Blue title 13

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.

Status
colour Blue title 16

Esta petición nos devolverá el identificador del expediente que acabamos de crear óo, en caso de existir, el identificador del expediente existente.

Status
colour Blue title 17

Una vez tenemos el identificador del expediente, podemos realizar la petición [GET] /expedientes/{id}

Status
colour Blue title 18

para obtener la información acerca del expedientemismo.

Status
colour Blue title 19

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}

Status
colour Blue title 20

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,

Status
colour Blue title 22

que nos devolverá un listado con todos los actos que cumplen con los filtros de búsqueda.

Status
colour Blue title 23