InaCátalogAPI

InaCátalog API (API de ahora en adelante) es una API Restful JSON para la implantación de datos en InaCátalog.

La API es un servicio web que proporciona métodos de entrada y salida de datos para facilitar la integración controlada de datos con InaCátalog. Usted mismo puede crear, consultar, modificar, borrar y consultar los datos que recibirá en la aplicación o los elementos salientes de la misma.

Una vez instalada la API, accediendo a la siguiente URL : ( http://tienda.inase.es:449/InaCatalogAPI ) puede ver listada toda la documentación de las acciones que puede realizar.

En el fragmento anterior se puede ver listadas las acciones de iClientes y iArticulos.

En la documentación de /Help puede entrar en cada uno de las referencias y se le detallará cada parámetro de entrada y de salida con el tipo de valor que se requiere junto con un ejemplo del elemento de entrada y de salida (JSON del elemento).

GET, PUT , POST y DELETE son los métodos posibles de llamada.

• GET: Este método sirve para leer (obtener) datos existentes. Es el método más sencillo de todos, ya que introduciendo la URL entera en un navegador se puede obtener toda la información solicitada.
• PUT: Este método sirve para actualizar datos ya existentes. En la URL compuesta se define el elemento a actualizar, mientras que en su método PUT se definirán los campos y valores que deben actualizarse en el procedimiento habitual de clave=valor.
• POST: Se utiliza este método para dar de alta un elemento. La URL compuesta indica qué tipo de elemento quiere darse de alta. En su método POST, mediante un JSON se indicarán qué valores tendrán los campos indicados. 
• DELETE: Sirve para eliminar un elemento. La URL compuesta indica qué objeto debe eliminarse. 

Todas las llamadas devuelven una respuesta en la que se indica si hubo un error o incidencia en la propia llamada. De lo contrario, obtendrá un JSON con la información solicitada (en el caso de GET) o información del elemento alterado con PUT, POST o DELETE.

La información de envío y recepción siempre será en formato JSON y se usará siempre el mismo modelo tanto para el envío como para la recepción. En cada Endpoint se detalla el JSON esperado junto con los tipos de los valores asociados.

Volviendo a la imagen de ejemplo anterior, veamos algunos casos. 

Con la primera llamada de iClientes (GET) obtiene un JSON con todos los clientes existentes:

GET > http(s)://[IP]/InaCatalogAPI/api/iClientes

Con la segunda acción se puede obtener un cliente dado un código de empresa y código de cliente:

GET > http(s)://[IP]/InaCatalogAPI/api/iClientes?empresa={empresa}&codcliente={codcliente}

En la tercera se obtiene una lista de clientes según empresa y filtrada por propiedad/valor, donde la propiedad es un nombre de campo y el valor es el asignado a ese campo. Ejemplo:

GET > http(s)://[IP]/InaCatalogAPI/api/iClientes?empresa=1&propiedad=codAgente&valor=01 

Esta llamada obtendría el listado de clientes de la empresa 1 asignados al agente 01.

El cuarto Endpoint (PUT) permite, dado una empresa y un código de cliente, modificar un cliente existente.

PUT > http(s)://[IP]/InaCatalogAPI/api/iClientes?empresa={empresa}&codcliente={codcliente}

El quinto Endpoint (POST) permite dar de alta un nuevo cliente.

POST > http(s)://[IP]/InaCatalogAPI/api/iClientes

Por último (DELETE) elimina un cliente según empresa y código de cliente.

DELETE > http(s)://[IP]/InaCatalogAPI/api/iClientes?empresa={empresa}&codcliente={codcliente}

Todos los elementos contienen estos o similares Endpoints donde poder gestionar los datos sobre los que se construye InaCátalog. De esta forma, usted puede personalizar y controlar tanto los datos que entran como la información que recibe en las actualizaciones.

REF:VAB,VMM,JAEV