Descripción de la llamada.

Petición POST hacia https://www.gpfd.es/api/leer_documento.php


Codificación UTF8.


Parámetros de envio:

  • apikey: (Obligatorio) Identificador de envío de un administrador.
  • id: (Obligatorio si tipo y codigo no aparecen) Identificador interno del del documento dentro de la plataforma.
  • tipo:(Obligatorio si id no aparece)Tipo del documento (1,2,3).
  • codigo: (Obligatorio si id no aparece) Identificador del documento usado por la aplicación emisora


Respuesta al envío (jSON):

  • id: Identificador del documento.
  • asunto: Asunto del mensaje enviado.
  • cuerpo: Cuerpo del mensaje enviado.
  • fecha: Fecha del documento (DD/MM/AAAA).
  • importe: Importe del documento.
  • pagado: Booleano con el valor del estado.
  • fecha_pago: Fecha que se realizó el pago (DD/MM/AAAA).
  • medio_pago: Medio que se utilizó para realizar el pago.
  • cod_pago: Código de la operación del pago.
  • archivo: url de descarga del documento pdf.
  • 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 pagados a través de las api si es un administrador.



Se comprueba:


  • que todos los campos obligatorios existen.
  • la integridad de cada campo.
  • si el id indicado existe en la plataforma.
  • si el tipo y codigo existe en la plataforma.


La identificación del documento puede ser bien por su id, o por el tipo y codigo interno, dando prioridad a su id en el caso de ser facilitado los dos.



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.
  • "No se encontraron datos": El documento no existe o ha sido borrado.



Código de ejemplo.

<!DOCTYPE html>
<html lang="es" dir="ltr">

<head>
    <meta charset="UTF-8">
    <title>Lectura del documento</title>
</head>

<body>
    <Form action = "https://www.gpfd.es/api/leer_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/>
        <input type="submit" value="enviar">
    </Form>
</body>
</html>