Índice

1 Introducción
2 Autenticación
- 2.1 [GET] /login
3 Generales
- 3.1 [GET] /filtros
- 3.2 [GET] /empresas
- 3.3 [GET] /estados
- 3.4 [GET] /idiomas/descripciones
- 3.5 [GET] /modalidades
- 3.6 [GET] /monedas
- 3.7 [GET] /paises
- 3.8 [GET] /tipos/contactos
- 3.9 [GET] /tipos/descripciones
- 3.10 [GET] /tipos/domicilios
4 Contactos
5 Expedientes
- 5.1 [GET] /expedientes/{id}
- 5.2 [PUT] /expedientes/{id}
- 5.3 [POST] /expedientes
- 5.4 [POST] /expedientes/search
- 5.5 [GET] /expedientes/{id}/titulares
- 5.6 [POST] /expedientes/{id}/titulares
- 5.7 [POST] /expedientes/actos/search
6 Facturas Recibidas
- 6.1 [POST] /facturas/recibidas

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	Sí	192.168.293.365
<puerto>	Puerto API	Sí	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	Sí	`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

GET /login

Request URL

http://<dominio>:<puerto>/login?username=<username>&password=<password>

cURL

curl --location --request GET 'http://<dominio>:<puerto>/login?username=<username>&password=<password>'

Parámetro	Descripción	Obligatorio	Ejemplo
<username>	Nombre usuario	Sí	maria1294
<password>	Contraseña usuario	Sí	admin

Ejemplo de request URL

http://192.168.293.365:8071/login?username=maria1294&password=admin

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/login?username=maria1294&password=admin'

Para el método de login no hace falta incluir headers

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH"
}

401 Usuario no autorizado

{
  "statusCode": 401,
  "message": "Usuario no autorizado",
  "data": null
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

Generales

[GET] /filtros

Descripción

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

Petición

GET /filtros

Request URL

http://<dominio>:<puerto>/filtros

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/filtros

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/filtros' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "EQ",
            "descripcion": "Igual que el/los valor(es)"
        },
        {
            "codigo": "BT",
            "descripcion": "Between - Resultados entre dos valores"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /empresas

Descripción

Devuelve un listado con las empresas disponibles.

Petición

GET /empresas

Request URL

http://<dominio>:<puerto>/empresas'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/empresas'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/empresas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        { 
            "codigo": "E1",
            "descripcion": "Empresa 1",
            "pais": {
                  "codigo": "ES",
                  "descripcion": "España"
            },
            "moneda": {
                  "codigo": "EUR",
                  "descripcion": "Moneda de los estados miembros de EMU"
            },
            "CIF": "R2788776B"
        },
        {
            "codigo": "E2",
            "descripcion": "Empresa 2",
            "pais": {
                  "codigo": "ES",
                  "descripcion": "España"
            },
            "moneda": {
                  "codigo": "EUR",
                  "descripcion": "Moneda de los estados miembros de EMU"
            },
            "CIF": "E0413308""
        },
        {
            "codigo": "E3",
            "descripcion": "Empresa 3",
            "pais": {
                  "codigo": "ES",
                  "descripcion": "España"
            },
            "moneda": {
                  "codigo": "EUR",
                  "descripcion": "Moneda de los estados miembros de EMU"
            },
            "CIF": "R2777776B"
        },
        {
            "codigo": "E4",
            "descripcion": "Empresa 4",
            "pais": {
                  "codigo": "ES",
                  "descripcion": "España"
            },
            "moneda": {
                  "codigo": "EUR",
                  "descripcion": "Moneda de los estados miembros de EMU"
            },
            "CIF": "V04182408"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /estados

Descripción

Devuelve un listado con los estados disponibles.

Petición

GET /estados

Request URL

http://<dominio>:<puerto>/estados

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/estados

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/estados' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "A",
            "descripcion": "Alta"
        },
        {
            "codigo": "B",
            "descripcion": "Baja"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /idiomas/descripciones

Descripción

Devuelve un listado con los idiomas disponibles.

Petición

GET /idiomas/descripciones

Request URL

http://<dominio>:<puerto>/idiomas/descripciones'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/idiomas/descripciones'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/idiomas/descripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "bg",
            "descripcion": "Búlgaro"
        },
        {
            "codigo": "en",
            "descripcion": "Inglés"
        },
        {
            "codigo": "es",
            "descripcion": "Español"
        },
        {
            "codigo": "et",
            "descripcion": "Estonio"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /modalidades

Descripción

Devuelve un listado con las modalidades disponibles.

Petición

GET /modalidades

Request URL

http://<dominio>:<puerto>/modalidades'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/modalidades'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/modalidades' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "A",
            "descripcion": "Marca de la Unión Europea"
        },
        {
            "codigo": "H",
            "descripcion": "Marca Internacional"
        },
        {
            "codigo": "P",
            "descripcion": "Patente"
        },
        {
            "codigo": "U",
            "descripcion": "Modelo de Utilidad"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /monedas

Descripción

Devuelve un listado con las monedas disponibles.

Petición

GET /monedas

Request URL

http://<dominio>:<puerto>/monedas'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/monedas'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/monedas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "EUR",
            "descripcion": "Moneda de los estados miembros de EMU"
        },
        {
            "codigo": "GBP",
            "descripcion": "Libra Británica"
        },
        {
            "codigo": "USD",
            "descripcion": "Dólar Americano"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /paises

Descripción

Devuelve un listado con los países disponibles.

Petición

GET /paises

Request URL

http://<dominio>:<puerto>/paises'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/paises'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/paises' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "AL",
            "descripcion": "Albania"
        },
        {
            "codigo": "AM",
            "descripcion": "Armenia"
        },
        {
            "codigo": "AR",
            "descripcion": "Argentina"
        },
        {
            "codigo": "AS",
            "descripcion": "Samoa Americana (American Samoa)"
        },
        {
            "codigo": "AT",
            "descripcion": "Austria"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /tipos/contactos

Descripción

Devuelve un listado con los tipos disponibles para contactos.

Petición

GET /tipos/contactos

Request URL

http://<dominio>:<puerto>/tipos/contactos'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/tipos/contactos'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/tipos/contactos' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "A",
            "descripcion": "Agente"
        },
        {
            "codigo": "B",
            "descripcion": "Abogado"
        },
        {
            "codigo": "C",
            "descripcion": "Cliente"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /tipos/descripciones

Descripción

Devuelve un listado con los tipos disponibles para las descripciones.

Petición

GET /tipos/descripciones

Request URL

http://<dominio>:<puerto>/tipos/descripciones'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/tipos/descripciones'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/tipos/descripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "DT",
            "descripcion": "Denominación"
        },
        {
            "codigo": "DE",
            "descripcion": "Descripción"
        },
        {
            "codigo": "IN",
            "descripcion": "Indicación"
        },
        {
            "codigo": "RE",
            "descripcion": "Renuncia"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /tipos/domicilios

Descripción

Devuelve un listado con los tipos disponibles para los domicilios.

Petición

GET /tipos/domicilios

Request URL

http://<dominio>:<puerto>/tipos/domicilios'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/tipos/domicilios'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/tipos/domicilios' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
         {
            "codigo": "A",
            "descripcion": "Etiqueta Alternativa"
        },
        {
            "codigo": "C",
            "descripcion": "Solo Correspondencia"
        },
        {
            "codigo": "F",
            "descripcion": "Solo Facturación"
        },
        {
            "codigo": "G",
            "descripcion": "Genérico"
        }
    ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

Contactos

[GET] /contactos/{id}

Descripción

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

Petición

GET /contactos/<id>

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450

Request URL

http://<dominio>:<puerto>/contactos/<id>'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/contactos/3992'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/contactos/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": {
        "id": 1,
        "codigo": "4879",
        "tipo": {
            "codigo": "C",
            "descripcion": "Cliente"
        },
        "referencia": "RF39438948",
        "estado": {
            "codigo": "A",
            "descripcion": "Alta"
        },
        "domicilios": [
            {
                "id": 442,
                "nombre": "Jose",
                "apellidos": "García",
                "domicilio": "Wayna Aero",
                "poblacion": "Valencia",
                "tipo": {
                    "codigo": "G",
                    "descripcion": "Genérico"
                }
            }
        ],
        "titulares": [
            {
                "id": 1,
                "nombre": null,
                "apellidos": "Empresa S.A."
            },
            {
                "id": 2,
                "nombre": "Juan",
                "apellidos": "Gómez"
            }        
        ]      
    }
}

404 No se ha encontrado el contacto

{
    "statusCode": 404,
    "message": "No se ha encontrado el contacto",
    "data": null
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[POST] /contactos

Descripción

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

Petición

POST /contactos

Request URL

http://<dominio>:<puerto>/contactos'

cURL

curl --location --request POST 'http://<dominio>:<puerto>/contactos' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del contacto que queremos crear	Sí

Body (request)

{
  "codigo": <codigo>,
  "tipo": <tipo>,
  "estado": <estado>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<codigo>	Código del contacto	Sí	Cadena de caracteres	10 caracteres	58634
<tipo>	Tipo del contacto. Consultar petición [GET] /tipos/contactos para más información	Sí	Cadena de caracteres	Único carácter	C
<estado>	Estado del contacto. Consultar petición [GET] /estados para más información	No	Cadena de caracteres	Único carácter	B

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json

No olvidar el token

Ejemplo de request URL

http://192.168.293.365:8071/contactos'

Ejemplo de body

{
  "codigo": "58634",
  "tipo": "C",
  "estado": "B"
}

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/contactos' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "codigo": "58634",
  "tipo": "C",
  "estado": "B"
}'

Responses validaciones de campos

400 Valor no válido para el campo ‘tipo’

{
    "statusCode": 400,
    "message": "Valor 'X' no válido para el campo 'tipo'. [GET]  /tipos/contactos para más información",
    "data": null
}

400 Valor no válido para el campo ‘estado’

{
    "statusCode": 400,
    "message": "Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información",
    "data": null
}

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": 3992
}

409 Ya existe el contacto que está intentando crear

{
    "statusCode": 409,
    "message": "Ya existe el contacto que está intentando crear",
    "data": 3992
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[POST] /contactos/search

Descripción

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

Petición

POST /contactos/search

Petición con opciones de paginación

POST /contactos/search?PageSize=<size>&PageNumber=<number>

Request URL

http://<dominio>:<puerto>/contactos/search'

Request URL con opciones de paginación

http://<dominio>:<puerto>/contactos/search?PageSize=<size>&PageNumber=<number>'

Parámetro	Descripción	Obligatorio	Ejemplo
<size>	Número de elementos por página	No	10
<number>	Número de página	No	2

cURL

curl --location --request POST 'http://<dominio>:<puerto>/contactos/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

cURL con opciones de paginación

curl --location --request POST 'http://<dominio>:<puerto>/contactos/search?PageSize=<size>&PageNumber=<number>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Conjunto de filtros a aplicar sobre la búsqueda	No

Body (request)

{
  "domicilios": [
    {
      "campo": <campo>,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ],
  "titulares": [
    {
      "campo": <campo>,,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ],
  "generales": [
    {
      "campo": <campo>,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ]
}

Parámetro	Descripción	Obligatorio	Tipo parámetro
<campo>	Campo por el que se va a aplicar el filtro dentro del bloque al que corresponde. En este caso, sobre contactos, domicilios o titulares	Sí	Cadena de caracteres
<valores>	Lista de valores	Sí	Lista de valores
<filtro>	Tipo de filtro a aplicar. Consultar petición [GET] /filtros para más información	Sí	Cadena de caracteres

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json

No olvidar el token

Ejemplo de request URL

http://192.168.293.365:8071/contactos/search'

Ejemplo de request URL con opciones de paginación

http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2'

Ejemplo de body

{
  "domicilios": [
    {
      "campo": "apellidos",
      "valores": [
        "García"
      ],
      "codigo": "EQ"
    }
  ],
  "titulares": [
    {
      "campo": "apellidos",
      "valores": [
        "S.A."
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "codigo",
      "valores": [
        "424"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "tipo",
      "valores": [
        "C",
        "A"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "RF239348"
      ],
      "codigo": "EQ"
    }
  ]
}

Campo	Descripción	Obligatorio	Tipo parámetro
“apellidos”	Filtro sobre el campo apellidos de titulares o domicilios (dependiendo del bloque en el que se encuentre)	No	Cadena de caracteres
“codigo”	Filtro sobre el código de contacto	No	Cadena de caracteres
“tipo”	Filtro sobre el tipo de contacto	No	Cadena de caracteres
“referencia”	Filtro sobre la referencia del contacto	No	Cadena de caracteres

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/contactos/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domicilios": [
    {
      "campo": "apellidos",
      "valores": [
        "García"
      ],
      "codigo": "EQ"
    }
  ],
  "titulares": [
    {
      "campo": "apellidos",
      "valores": [
        "S.A."
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "codigo",
      "valores": [
        "424"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "tipo",
      "valores": [
        "C",
        "A"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "RF239348"
      ],
      "codigo": "EQ"
    }
  ]
}'

Ejemplo de cURL con opciones de paginación

curl --location --request POST 'http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domicilios": [
    {
      "campo": "apellidos",
      "valores": [
        "García"
      ],
      "codigo": "EQ"
    }
  ],
  "titulares": [
    {
      "campo": "apellidos",
      "valores": [
        "S.A."
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "codigo",
      "valores": [
        "424"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "tipo",
      "valores": [
        "C",
        "A"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "RF239348"
      ],
      "codigo": "EQ"
    }
  ]
}'

Responses validaciones de campos

400 Valor no válido para el campo ‘codigo’

{
    "statusCode": 400,
    "message": "Filtro 'X' no contemplado. [GET] /filtros para más información",
    "data": null
}

400 Valor no válido para el campo ‘campo’

{
    "statusCode": 400,
    "message": "Campo 'X' no contemplado",
    "data": null
}

400 Lista de valores vacía

{
    "statusCode": 400,
    "message": "Se deben informar valores para el tipo de filtro 'EQ'",
    "data": null
}

400 Lista de ‘valores’ con valor vacío

{
    "statusCode": 400,
    "message": "El valor no puede ser nulo",
    "data": null
}

400 Filtro ‘Between’ con más de dos valores

{
    "statusCode": 400,
    "message": "El filtro 'BT' tiene que tener únicamente dos valores",
    "data": null
}

Headers responses

En esta petición, además de devolver un listado con los contactos que cumplen los filtros de búsqueda, en la cabecera de la respuesta se devuelve el parámetro X-Pagination con la siguiente información:

{"TotalCount":<total>,"PageSize":<size>,"CurrentPage":<current_page>,"TotalPages":<total_pages>,"HasNextPage":<has_next_page>,"HasPreviousPage":<has_previous_page>,"NextPageUrl":<next_url>,"PreviousPageUrl":<previous_url>}

Parámetro	Descripción
<total>	Número total de contactos encontrados en la búsqueda
<size>	Número de elementos por página
<current_page>	Página actual
<total_pages>	Número total de páginas
<has_next_page>	Indica si hay página siguiente
<has_previous_page>	Indica si hay página anterior
<next_url>	URL de la siguiente página
<previous_url>	URL de la página anterior

Ejemplo headers responses

{"TotalCount":2432,"PageSize":10,"CurrentPage":1,"TotalPages":244,"HasNextPage":true,"HasPreviousPage":false,"NextPageUrl":"","PreviousPageUrl":""}

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "codigo": "4879",
      "tipo": {
        "codigo": "C",
        "descripcion": "Cliente"
      },
      "referencia": "RF39438948",
      "estado": {
        "codigo": "B",
        "descripcion": "Baja"
      },
      "domicilios": [
        {
          "id": 4,
          "nombre": "María",
          "apellidos": "García",
          "domicilio": "Calle Los Arenales",
          "poblacion": "Valencia",
          "tipo": {
            "codigo": "G",
            "descripcion": "Genérico"
          }
        }
      ],
      "titulares": [
        {
           "id": 1,
           "nombre": null,
           "apellidos": "Empresa S.A."
        },
        {
           "id": 2,
           "nombre": "Juan",
            "apellidos": "Gómez"
        }        
      ]      
    },
    {
      "id": 2,
      "codigo": "68798",
      "tipo": {
        "codigo": "A",
        "descripcion": "Agente"
      },
      "referencia": "DG29849348",
      "estado": {
        "codigo": "A",
        "descripcion": "Alta"
      },
      "domicilios": [],
      "titulares": []
    }
  ]
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[GET] /contactos/{id}/domicilios

Descripción

Obtiene los domicilios de un contacto.

Petición

GET /contactos/<id>/domicilios

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450

Request URL

http://<dominio>:<puerto>/contactos/<id>/domicilios'

cURL

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

Importante: no olvidar headers

Ejemplo de request URL

http://192.168.293.365:8071/contactos/3992/domicilios'

Ejemplo de cURL

curl --location --request GET 'http://192.168.293.365:8071/contactos/3992/domicilios' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "id": 1,
            "nombre": "Natalia",
            "apellidos": "García",
            "domicilio": "Wayna Aero",
            "poblacion": "Valencia",
            "tipo": {
                "codigo": "A",
                "descripcion": "Etiqueta Alternativa"
            }
        },
        {
            "id": 2,
            "nombre": "María",
            "apellidos": "Fernandez",
            "domicilio": "Yedra Centro",
            "poblacion": "Madrid",
            "tipo": {
                "codigo": "G",
                "descripcion": "Genérico"
            }
        }
    ]
}

404 No se ha encontrado el contacto

{
    "statusCode": 404,
    "message": "No se ha encontrado el contacto",
    "data": null
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

[POST] /contactos/{id}/domicilios

Descripción

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

Petición

POST /contactos/<id>/domicilios

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450

Request URL

http://<dominio>:<puerto>/contactos/<id>/domicilios'

cURL

curl --location --request POST 'http://<dominio>:<puerto>/contactos/<id>/domicilios' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del domicilio que queremos crear	Sí

Body (request)

{
  "apellidos": <apellidos>,
  "tipo": <tipo>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<apellidos>	Apellidos	Sí	Cadena de caracteres	100 caracteres	García Fernández
<tipo>	Tipo del domicilio. Consultar petición [GET] /tipos/domicilios para más información	Sí	Cadena de caracteres	Único carácter	A

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json

No olvidar el token

Ejemplo de request URL

http://192.168.293.365:8071/contactos/<id>/domicilios'

Ejemplo de body

{
  "apellidos": "García Fernández",
  "tipo": "A"
}

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/contactos/6450/domicilios' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "apellidos": "García Fernández",
  "tipo": "A"
}'

Responses validaciones de campos

400 Valor no válido para el campo ‘tipo’

{
    "statusCode": 400,
    "message": "Valor 'X' no válido para el campo 'tipo'. [GET]  /tipos/domicilios para más información",
    "data": null
}

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": 3992
}

404 No se ha encontrado el contacto

{
    "statusCode": 404,
    "message": "No se ha encontrado el contacto",
    "data": null
}

409 Ya existe el domicilio que está intentando crear

{
    "statusCode": 409,
    "message": "Ya existe el domicilio que está intentando crear",
    "data": 3992
}

500 Ha ocurrido un error

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
}

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

Descripción

Modificación de un domicilio asociado a un contacto.

Petición

PUT /contactos/<id>/domicilios/<idDomicilio>

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450
<idDomicilio>	Identificador del domicilio a modificar	Sí	450

Request URL

http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>'

cURL

curl --location --request PUT 'http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del domicilio que queremos actualizar	Sí

Body (request)

{
  "apellidos": <apellidos>
}

Peticiones

Índice

Introducción

Estándar Request URL

Parámetro

Descripción

<dominio>

Dominio API

Sí

192.168.293.365

<puerto>

Puerto API

Sí

8080

Estándar cURL

Header

Descripción

<idioma>

Idioma para las descripciones

No

es

<token>

Token de acceso

Sí

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH

Ejemplo cURL con Headers

Estándar Response

Autenticación

[GET] /login

Descripción

Petición

Request URL

cURL

Parámetro

Descripción

<username>

Nombre usuario

Sí

maria1294

<password>

Contraseña usuario

Sí

admin

Ejemplo de request URL

Ejemplo de cURL

Responses

Generales

[GET] /filtros

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /empresas

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /estados

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /idiomas/descripciones

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /modalidades

`eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH`