Documentación API

API 1 comentario

Elementos necesarios para el manejo del API

  • Url servidor myGESTIÓN
  • Referencia a la tabla a la que queremos acceder
  • Parámetros adicionales
    • usuario
    • clave
    • “schema” (opcional)
      • “blank”
      • “psynopsis”
    • “filter” (opcional)
    • “sort” (opcional)
    • “limit” (opcional)
  • Métodos
    • GET (select)
    • POST  (update)
    • PUT (update)
  • Tablas disponibles
    • Api
    • ApiAlbaranesCliente
    • ApiAlbaranesProveedor
    • ApiAlmacenes
    • ApiArticulos
    • ApiClientes
    • ApiContactos
    • ApiDelegaciones
    • ApiDetallesAlbaranesCliente
    • ApiDetallesFacturasCliente
    • ApiDetallesPedidosCliente
    • ApiDivisas
    • ApiFacturasCliente
    • ApiFacturasProveedor
    • ApiFamilias
    • ApiFormasPago
    • ApiGrupos
    • ApiMarcas
    • ApiOrigenes
    • ApiPaises
    • ApiPedidosCliente
    • ApiPersonal
    • ApiPresupuestosCliente
    • ApiProveedores
    • ApiProvincias
    • ApiSeriesFacturasCliente
    • ApiStock
    • ApiSubfamilias
    • ApiTiposIVA
    • ApiTransportistas
    • ApiZonas

Para ver el listado de las tablas existe un índice en https://app04.mygestion.com/appMg/api/

Para acceder al API es necesario un usuario de myGESTIÓN, la URL del servidor y la tabla a la que se quiere acceder.Todas las tablas siguen la misma dinámica. A continuación, veremos unos ejemplos con la tabla de clientes:

https://app04.mygestion.com/appMg/api/ApiClientes/?user=usuario&password=password

Con esta llamada al método GET se nos devolverá un documento XML con la lista de clientes registrados en la base de datos.

Aquí tienes un ejemplo práctico.

 

 

ApiClientes.get con un código

Si añadimos a la URL el código del cliente que queremos seleccionar, nos devolverá un nuevo documento con los datos del cliente seleccionado:
https://app04.mygestion.com/appMg/api/ApiClientes/0?user=usuario&password=password

Ir al ejemplo.

 

 

ApiClientes.get ?schema=blank

Podemos añadir el parámetro “schema=blank” para que se nos devuelva un XML con la estructura de esa tabla para usar en los métodos UPDATE e INSERT:
https://app04.mygestion.com/appMg/api/ApiClientes/?user=usuario&password=password&schema=blank

Ir al ejemplo.

 

 

ApiClientes.get ?schema=psynopsis

Podemos añadir el parámetro “schema=psynopsis” para que se nos devuelva un XML con el tipo de dato de cada uno de los campos y el valor por defecto que se insertará en la BBDD si uno de estos campos se envía vacío:
https://app04.mygestion.com/appMg/api/ApiClientes/?user=usuario&password=password&schema=psynopsis

Ir al ejemplo.

 

 

Parámetros adicionales

“display”

display=[nombreCampo1,nombreCampo2,…]

El parámetro “display” junto con una enumeración de campos de esa tabla nos permite modificar los campos que se devuelven en el listado.

Ir al ejemplo.

 

“filter”

Replica la claúsula where de SQL:
filter=[campo]=[1]           =>where campo=1
filter=[campo]=[1|10]      =>where campo>=1 and campo <=10 solo 2 valores
filter=[campo]=[1,10,11] =>where campo=1 and campo =10 and campo =11 multiples valores

Se puede utilizar “%” para campos de tipo texto en los que sólo tengamos un indicio del dato a buscar
filter=[campo]=[asd%] =>where campo like ‘asd%’.

Ir al ejemplo.

En una URL el caracter ‘%’ se ha de codificar como ‘%25’.

“sort”

Permite ordenar los registros del resultado:
sort=[campo]=[DESC]/sort=[campo]=[ASC]

Campo: nombre del campo a ordenar.

Ir al ejemplo.

 

“limit”

Limita el número de registros:

limit=4    =>limit 4
limit=4,3 =>limit 4 offset 3

Ir al ejemplo.

 

ApiClientes.put (UPDATE)

Seleccionamos un cliente con GET, cambiamos los datos y enviamos este documento en una llamada a PUT. El cliente es modificado a partir de esta combinación de métodos..

Ir al ejemplo.

Cada tabla tiene una lista de campos que el XML debe incluir. En caso de que no coincidan el servidor devuelve un error.

Código de error 460

 

Si la base de datos devolviera un error, se captura y se envía en el response con el código 461.

Los códigos de error están sujetos a modificaciones.

 

ApiClientes.post (INSERT)

La funcionalidad y gestión de errores es igual a la de UPDATE.

Ir al ejemplo.

 

Tablas de maestros. Ejemplo: ApiGrupos

En este apartado se incluyen todas las tablas necesarias para insertar, por ejemplo, un cliente.
La funcionalidad es idéntica, salvo en el método UPDATE, para aquellas tablas que no tienen un campo ID/código, ya que en el caso de querer cambiar este no tendríamos una referencia para la cláusula where de SQL. Por tanto, se incluye en los XML un campo ‘newNombreDelCampoIndice’.

 

 

Otros

Verificación de usuario y contraseña, mensajes de error:

https://app04.mygestion.com/appMg/api/ApiClientes/0?user=usuario&password=ContraseñaIncorrecta

 

 

https://app04.mygestion.com/appMg/api/ApiClientes/0?user=usuarioIncorrecto&password=ContraseñaIncorrecta

 

 

Guías relacionadas

En la siguiente guía sobre la API de myGESTIÓN tienes una serie de ejemplos prácticos sobre su funcionamiento:

Una respuesta a “Documentación API”

Deja un comentario

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.