/api

Descripción del uso de la API Rest de Farmaconnect

Primary LanguageC

Image of Yaktocat

API Rest Farmaconnect

Descripción del uso de la API Rest de Farmaconnect

Información básica

A continuación se mostrarán las funciones básicas para implementar la API de Farmaconnect en cualquier entorno. Todas la peticiones HTTP se realizan en https://rest.farmaconnect.es

Obtención de Token de acceso

Servicios disponible ( Endpoints )

Endpoints Documentación
tag Métodos HTTP - Etiquetas
layout Métodos HTTP - Diseño etiquetas
flash Métodos HTTP - Flash Led
product Métodos HTTP - Artículos
list Métodos HTTP - Listado de productos
category Métodos HTTP - Categoría de productos
storehouse Métodos HTTP - Almacenes
info Métodos HTTP - Información

Para usar los servicios simplemente se añade la url + el endpoint.

Ejemplo: https://rest.farmaconnect.es/tag

Gestión de respuestas HTTP

Todas las peticiones devuelven una estructura en formato JSON (JavaScript Object Notation) con la siguiente estructura:

{
    status:200,
    error:null,
    result: {data} // String o Array de objetos
}

En peticiones con status 200, únicamente en los siguientes casos la respuesta se devolverá en formato String:

  • Obtención del token; devuelve un string con el Token
  • POST, PUT y DELETE; devuelve un objecto con sintaxis uuid V4
Respuesta (status) Nota
200 La petición se efectuó correctamente
400 No se ha podido finalizar la petición
404 En general no se ha encontrado la referencia
500 Se produjo un error en el lado de servidor

Recomendaciones: En el caso de que se produzca un error 500 o 400, se recomienda que se tenga implementado un gestor de cache evento, para poder reenviar más tarde la petición.

Pruebas de peticiones HTTP

En cualquier momento se pueden realizar pruebas de petición http. A continuación dejamos disponible como realizar dichas peticiones con postman.

Run in Postman

Bugs conocidos

No se han detectado ningún error