<< Haga clic para mostrar la tabla de contenido >> Navegación:  Fichas > Fichero de Empresas > Ficha > Api Connect

 

Configura la conexión y comunicación con API's de terceros

 

Activar conexión API habilita la comunicación general con el API configurada

Activa el enlace con clientes cuando se añada, modifique o elimine un cliente desde su ficha, se realizarán las conexiones correspondientes al API para su actualización

 

Configuración

En este apartado se configuran los parámetros de comunicación con el API. Se realiza mediante un fichero Json con las siguientes características:

- todos los campos de configuración deben estar en minúscula

 

name: Nombre del API al que se comunica

fichero: Nombre del fichero que se configura para la comunicación, puede ser cliente, artículo, proveedo dependiendo de la ficha que se active, pueden existir diferentes configuraciones una por cada tipo de fichero

url: array que indica las diferentes direcciones url del API para conectar según la acción que se realice:

create: especifica la url para añadir un recurso

update: especifica la url para modificar un recurso

delete: especifica la url para eliminar un recurso

Nota: update y delete pueden contener el literal {id} que será sustituido con el nº de id del recurso que se modifica, por ejemplo: https://url/api/cliente/{id}

headers: array que contiene las cabeceras necesarias para las peticiones al API.

body: array que contiene el cuerpo de la petición, en él se especifican los campos del API y su equivalencia con los campos del fichero de Visionwin. Se permite tener array de valores y array de valores llave tal y como se puede observar en el ejemplo de configuración.

response: array con los códigos de respuesta y resto de información necesaria para procesar las respuestas del API. Es necesario definir como mínimo los siguientes valores de respuesta:

create código de respuesta para una petición de creación de recurso satisfactoria

update código de respuesta para una modificación de recurso satisfactoria

delete código de respuesta para el borrado de un recurso satisfactorio

id nombre del campo que devuelve el id en la respuesta de creado de recurso.

 

Ejemplo de fichero de configuración:

 

{

    "name": "Nombre Api",

    "cliente":{

        "url": { 

                    "create":"https://url/api/clientes",

                    "update":"https://url/api/clientes/{id}",

                    "delete":"https://url/api/clientes/{id}"

                },

        "headers":{

                    "Authorization" : "Token autorización",

                    "Content-Type"  : "application/json"

                    },

        "body":{ 

                "name"         :        "NOMBRE",

                "email"        :        "EMAIL",

                "other_emails" :        ["EMAILDOC","EMAILFAC"],

               "other_phone_numbers" : [

                                         { "label":"gerencia",      "value":666666661 },

                                         { "label":"administracion","value":666666662 },

                                         { "label":"administracion","value":666666663 },

                                         { "label":null,            "value":666666664 }

                                       ],

                },

        "response":{

                    "create":201,

                    "update":200,

                    "delete":204,

                    "id":"id" 

                }

    }

}