Peticiones

Índice

Introducción

En este documento se van a detallar cada una de las peticiones que, actualmente, se pueden realizar en la API para cada bloque de Apiges Pro (Expedientes, Contactos…). Para el correcto funcionamiento y la obtención de los resultados esperados, se va a especificar en cada petición qué parámetros son obligatorios, los tipos de respuesta y ejemplos de las peticiones para entender mejor el funcionamiento.

Para ello, vamos a hablar primero de los parámetros/headers que comparten todas las peticiones que podemos realizar en la API:

Estándar Request URL

http://<dominio>:<puerto>

Parámetro

Descripción

Obligatorio

Ejemplo

<dominio>
Dominio API
192.168.293.365
<puerto>
Puerto API
8080

Estándar cURL

curl --location --request GET 'http://<dominio>:<puerto>/estados' \ --header 'accept-language: <idioma>' \ --header 'Authorization: Bearer <token>'

Header

Descripción

Obligatorio

Ejemplo

<idioma>
Idioma para las descripciones
No
es
<token>
Token de acceso
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH

Importante: El tipo de autenticación que se utiliza en la API es JWT, y su nomenclatura es: Bearer <token>

Opciones para el parámetro <idioma>:

  • Español: es (valor por defecto)

  • Francés: fr

  • Portugués: pt

  • Catalán: ca

  • Alemán: de

  • Inglés: en

  • Italiano: it

Ejemplo cURL con Headers

curl --location --request GET 'http://<dominio>:<puerto>/estados' \ --header 'accept-language: de' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Estándar Response

Para garantizar la seguridad de la API, se realiza una comprobación a nivel global sobre cada petición para evaluar el token de acceso. Esta validación del token puede provocar dos tipos de respuesta en las peticiones (además de las particulares de cada una de ellas):

401 Usuario no autorizado

403 El usuario no tiene permisos para este ámbito

En caso de obtener alguna de estas dos respuestas, intenta autenticarte de nuevo y, si el error persiste, ponte por favor en contacto con Grupo10 a través del apartado Soporte

Autenticación

[GET] /login

Descripción

Método de autenticación a la API. Devuelve un token de acceso a utilizar en el resto de peticiones de la API.

Petición

Request URL

cURL

Parámetro

Descripción

Obligatorio

Ejemplo

<username>
Nombre usuario
maria1294
<password>
Contraseña usuario
admin

Ejemplo de request URL

Ejemplo de cURL

Responses

200 Ha ido correctamente

401 Usuario no autorizado

500 Ha ocurrido un error

Generales

[GET] /filtros

Descripción

Devuelve un listado con los filtros disponibles en las búsquedas.

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

200 Ha ido correctamente

500 Ha ocurrido un error

[GET] /empresas

Descripción

Devuelve un listado con las empresas disponibles.

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

200 Ha ido correctamente

500 Ha ocurrido un error

[GET] /estados

Descripción

Devuelve un listado con los estados disponibles.

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

200 Ha ido correctamente

500 Ha ocurrido un error

[GET] /idiomas/descripciones

Descripción

Devuelve un listado con los idiomas disponibles.

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

200 Ha ido correctamente

500 Ha ocurrido un error

[GET] /modalidades

Descripción

Devuelve un listado con las modalidades disponibles.

[GET] /monedas

Descripción

Devuelve un listado con las monedas disponibles.

[GET] /paises

Descripción

Devuelve un listado con los países disponibles.

[GET] /tipos/contactos

Descripción

Devuelve un listado con los tipos disponibles para contactos.

[GET] /tipos/descripciones

Descripción

Devuelve un listado con los tipos disponibles para las descripciones.

[GET] /tipos/domicilios

Descripción

Devuelve un listado con los tipos disponibles para los domicilios.

Contactos

[GET] /contactos/{id}

Descripción

Obtiene la información de un contacto, a partir de su identificador.

[POST] /contactos

Descripción

Creación de un nuevo contacto. Devuelve el identificador del contacto creado o existente

[POST] /contactos/search

Descripción

Búsqueda de contactos con filtros. Devuelve un listado con los contactos que cumplen los filtros de búsqueda.

[GET] /contactos/{id}/domicilios

Descripción

Obtiene los domicilios de un contacto.

[POST] /contactos/{id}/domicilios

Descripción

Creación de un nuevo domicilio asociado a un contacto. Devuelve el identificador del domicilio creado o existente.

[PUT] /contactos/{id}/domicilios/{idDomicilio}

Descripción

Modificación de un domicilio asociado a un contacto.

[GET] /contactos/{id}/titulares

Descripción

Obtiene los titulares de un cliente.

[POST] /contactos/{id}/titulares

Descripción

Creación de un titular a un cliente en concreto. Devuelve el identificador del titular creado o existente.

Expedientes

[GET] /expedientes/{id}

Descripción

Obtiene la información de un expediente a partir de su identificador.

[PUT] /expedientes/{id}

Descripción

Modificación de un expediente.

[POST] /expedientes

Descripción

Creación de un nuevo expediente. Devuelve el identificador del expediente creado o existente.

[POST] /expedientes/search

Descripción

Búsqueda de expedientes con filtros. Devuelve un listado con los expedientes que cumplen los filtros de búsqueda.

[GET] /expedientes/{id}/titulares

Descripción

Obtiene los titulares de un expediente.

[POST] /expedientes/{id}/titulares

Descripción

Asignación de un titular a un expediente.

[POST] /expedientes/actos/search

Descripción

Búsqueda de actos con filtros. Devuelve un listado con los actos que cumplen los filtros de búsqueda.

Facturas Recibidas

[POST] /facturas/recibidas

Creación de una nueva factura recibida. Devuelve el identificador de la factura creada.