Descripción de la llamada.
Petición POST hacia https://www.gpfd.es/api/nuevo_documento.php
Codificación UTF8
Parámetros de envio:
- apikey: (Obligatorio) Identificador de envío de un administrador. Código único generado para cada usuario, generado por la plataforma.
- codigo: (Obligatorio) Código identificador del documento. Este código es el que usa la aplicación emisora para identificar el documento. Alfanumérico
- tipo: (Obligatorio) Tipo del documento, puede ser
- 1.- Notificaciones.
- 2.- Facturas.
- 3.- Albarán
- fecha: (Obligatorio)Fecha del documento: DD/MM/AAAA
- email: (Obligatorio) Dirección del correo electrónico donde entregar el documento con el aviso de pago.
- telefono: (Opcional): Número de teléfono dentro del territorio español para notificar via SMS de la recepción del pago pendiente.
- asunto: (Obligatorio) Asunto de la notificación del documento. Admite lenguaje html
- cuerpo: (Obligatorio) Cuento de la notificación del documento. Admite lenguaje html
- importe: (Obligatorio) Importe del documento. Entero con decimales separados por punto (#####.##)
- archivo: (Opcional) Archivo del documento con formato PDF . Peso <= 20 MB.
Respuesta al envío (jSON):
- id: Identificador de la factura. Numérico que le asigna la plataforma al documento y que lo identifica de forma única dentro de la misma.
- error: Descripción del error.
Comportamiento de la API.
Recibida la petición se verifica si el apikey solicitado es válido para el envío de documentos. Los documentos únicamente podrán ser enviados a través de las api, si este pertenece a un administrador.
Se comprueba:
- que no exista ya un documento en la plataforma para ese apikey con el mismo tipo y el mismo codigo.
- que todos los campos obligatorios aparecen.
- la integridad de cada campo.
Respuesta: Si el id es igual a 0, es que se ha producido en error y no se ha grabado el documento en la plataforma.
Los errores pueden contener los siguientes mensajes:
- "Usuario no identificado": Ocurre si no se ha comunicado el apikey, o este no es válido.
- "Usuario no autorizado": El apikey es correcto, pero no se trata de un administrador.
- "Información facilitada incorrecta": Falta algún campo obligatorio o hay alguno que no cumple los requisitos.
- "Error procesando archivo adjunto": Existe algún error en el procesamiento del archivo adjunto.
- "Datos actualizados": Ya existe un documento del mismo tipo con el mismo codigo, actualiza el contenido del documento con los nuevos facilitados.
Ejemplo código.
<!DOCTYPE html>
<html lang="es" dir="ltr">
<head>
<meta charset="UTF-8">
<title>Nuevo documento</title>
</head>
<body>
<Form action = "https://www.gpfd.es/api/nuevo_documento.php" method = "post">
<label for="apikey">Api Key: </label><input type="text" name="apikey" value="34343ss" required="required"><br/>
<label for="codigo">Código documento: </label><input type="number" name="codigo" value ="3"><br/>
<label for="tipo">Tipo documento: </label><input type="text" name="tipo" value ="2"><br/>
<label for="fecha">Fecha de documento: </label><input type="text" name="fecha" value ="01/01/2017"><br/>
<label for="email">Email destinatario: </label><input type="email" name="email" value ="destinatario@gpfd.es"><br/>
<label for="asunto">Asunto: </label><input type="text" name="asunto" value ="Asunto del mensaje"><br/>
<label for="cuerpo">Cuerpo: </label><input type="text" name="cuerpo" value ="Cuerpo del mensaje"><br/>
<label for="importe">Importe: </label><input type="number" name="importe" value ="10">€<br/>
<label for="archivo">Archivo: </label><input type="file" name="archivo" accept="application/pdf"><br/>
<input type="submit" value="enviar">
</Form>
</body>
</html>