Para realizar el registro de un nuevo velatorio, es necesario realizar una petición HTTP POST (con un token válido en el header Authorization) contra la URL https://api.vivorecuerdo.es/v1/velatorios con un JSON con el siguiente formato:
{
"fecha_defuncion": <fecha de defunción (DD/MM/AAAA)>*,
"localidad": <localidad de defunción>*,
"nombre": <nombre del fallecido>*,
"apellidos": <apellidos del fallecido>*,
"sobrenombre": <sobrenombre>,
"fecha_nacimiento": <fecha de nacimiento (DD/MM/AAAA)>*,
"lugar_nacimiento": <localidad de nacimiento>*,
"provincia_pais_nacimiento": <provincia o país de nacimiento>*,
"fecha_ceremonia": <fecha de la ceremonia (DD/MM/AAAA)>,
"lugar_ceremonia": <lugar de la ceremonia>,
"poblacion_ceremonia": <población de la ceremonia>,
"hora_ceremonia": <hora de la ceremonia (hh:mm)>,
"texto_adicional": <texto adicional>,
"cementerio_crematorio": <cementerio o crematorio (cementerio/crematorio)>,
"poblacion_cementerio_crematorio": <población del cementerio/crematorio>,
"nombre_opcional_cementerio_crematorio": <nombre opcional del cementerio/crematorio>,
"fecha_cementerio_crematorio": <fecha del entierro/cremación (DD/MM/AAAA)>,
"hora_cementerio_crematorio": <hora del entierro/cremación (hh:mm)>,
"fecha_fin_servicio": <fecha de fin de servicio (DD/MM/AAAA)>,
"hora_fin_servicio": <hora de fin de servicio (hh:mm)>,
"dni_rut": <DNI o RUT>,
"nombre_sala": <nombre de la sala)>*,
"idioma_velatorio": <idioma del velatorio>*,
"tlf_admin_1": <teléfono del administrador 1>*,
"tlf_admin_2": <teléfono del administrador 2>,
"tlf_admin_3: <teléfono del administrador 3>,
"tlf_admin_4: <teléfono del administrador 4>,
"tlf_admin_5: <teléfono del administrador 5>,
}Los campos marcados con * son obligatorios.
Es importante tener en cuenta que las fechas se introducen en formato "DD/MM/AAAA" y las horas en "hh:mm" (siendo los minutos múltiplos de cinco, es decir, "11:00", "11:05", "11:10", etc.). En el caso de los campos "fecha_ceremonia" y "hora_ceremonia", estas fechas/horas han de ser siempre posteriores a la fecha/hora del registro del velatorio.
En cuanto al campo "cementerio_crematorio", en este se indica "cementerio" si el fallecido va a ser enterrado en un cementerio o "crematorio" si va a ser incinerado.
Respecto a los teléfonos de administradores, es muy importante rellenarlos por orden. Por ejemplo, si hay dos administradores, han de ocupar los campos "tlf_admin_1" y "tlf_admin_2", de lo contrario se pueden producir inconsistencias.
Para el campo "idioma_velatorio" hay que elegir entre castellano ("es_ES"), inglés ("en_GB"), catalán ("ca_ES") o portugués ("pt_PT").
Por otro lado, los números de teléfono de los administradores pueden introducirse con o sin código de país (+34 XXXXXXXXX ó XXXXXXXXX) en el caso de números españoles, en el caso de números internacionales es obligatorio el uso del código de país.
Importante que los números de teléfono introducidos durante las pruebas de integración no sean aleatorios, ya que el sistema automáticamente envía un SMS a los administradores para que puedan hacer uso del servicio.
Por ejemplo, con cURL:
curl -X POST https://api.vivorecuerdo.es/v1/velatorios -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJkZXNhcnJvbGxvIiwiaXNzIjoidml2b3JlY3VlcmRvIiwidHlwZSI6IkFVVEhFTlRJQ0FUSU9OIiwiaWF0IjoxNTY1MjY5MDkwLCJleHAiOjE1NjUyNzI2OTB9.mUwuoy6LJF8hI3v9w4hZPaLLqkFLSTani5tlKr8Q2_4OzcCGC-TSc8zNY7oVRT7bGiOdtr5QI7cPbaQdelhG-A' -H 'Content-Type: application/json' -d '{
"fecha_defuncion": "04/12/2017",
"localidad": "Torre Pacheco",
"nombre": "Rafael",
"apellidos": "Baeza López",
"fecha_nacimiento": "20/07/1939",
"lugar_nacimiento": "Lora del Río",
"provincia_pais_nacimiento": "Sevilla",
"fecha_ceremonia": "31/12/2020",
"lugar_ceremonia": "Parroquia Ntra. Sra. del Rosario",
"poblacion_ceremonia": "Torre Pacheco",
"hora_ceremonia": "11:00",
"cementerio_crematorio": "cementerio",
"poblacion_cementerio_crematorio": "Torre Pacheco",
"nombre_opcional_cementerio_crematorio": "Municipal",
"fecha_cementerio_crematorio": "31/12/2020",
"hora_cementerio_crematorio": "12:00",
"fecha_fin_servicio": "31/12/2020",
"hora_fin_servicio": "18:00",
"nombre_sala": "Sala 1",
"idioma_velatorio": "es_ES",
"tlf_admin_1": "+34 XXXXXXXXX",
"tlf_admin_2": "XXXXXXXXX",
"tlf_admin_3: "XXXXXXXXX",
}'
Si el registro se ha realizado correctamente, la API devuelve un código 201 y otro JSON que incluye, además de los datos registrados, el "id" y la "url_corta" generados para ese velatorio. Es importante conservar ese id, ya que es el que permitirá realizar modificaciones en el velatorio. En caso de perderlo, siempre se puede realizar una consulta de los velatorios activos para recuperarlo.
Ejemplo del JSON devuelto:
{
"id" : 121
"fecha_defuncion": "04/12/2017",
"localidad": "Torre Pacheco",
"nombre": "Rafael",
"apellidos": "Baeza López",
"fecha_nacimiento": "20/07/1939",
"lugar_nacimiento": "Lora del Río",
"provincia_pais_nacimiento": "Sevilla",
"fecha_ceremonia": "31/12/2020",
"lugar_ceremonia": "Parroquia Ntra. Sra. del Rosario",
"poblacion_ceremonia": "Torre Pacheco",
"hora_ceremonia": "11:00",
"cementerio_crematorio": "cementerio",
"poblacion_cementerio_crematorio": "Torre Pacheco",
"nombre_opcional_cementerio_crematorio": "Municipal",
"fecha_cementerio_crematorio": "31/12/2020",
"hora_cementerio_crematorio": "12:00",
"fecha_fin_servicio": "31/12/2020",
"hora_fin_servicio": "18:00",
"nombre_sala": "Sala 1",
"idioma_velatorio": "es_ES",
"tlf_admin_1": "+34 XXXXXXXXX",
"tlf_admin_2": "XXXXXXXXX",
"tlf_admin_3: "XXXXXXXXX",
"url_corta": "vrdo.es/xxxx",
}
Si la petición falla, la API devuelve un error 403 en caso de que sea por falta de permisos, un error 400 en caso de que no se hayan introducido bien los datos por parte del tanatorio, o un error 500 en caso de un error en el servidor.