Introducción

El API de Bind ERP es un conjunto de servicios que te permite interactuar de forma sencilla y segura a toda la información de tu PYME. Nuestra interfaz RESTful te permitirá tener acceso a la mayoría de la información con la que cuentas en el portal de Bind ERP. Este documento proporciona información a los desarrolladores sobre cómo integrarse con la API de Bind ERP.

URL Base

Todas las URLs referenciadas en esta documentación tienen la siguiente base.

https://api.bind.com.mx

Autenticación

Obtén tu clave API (API Key)

Para autenticar tu cuenta cuando uses la API debes incluir tu clave secreta de API en la solicitud (API Key).

Puedes generar tu clave API en tu Perfil de Usuario al cual puedes acceder dando clic a tu nombre de usuario, que se encuentra en la parte superior derecha, y después da clic en Perfil.

Posteriormente, en la sección Perfil de Usuario, da clic en la pestaña de Integraciones, introduce tu contraseña y da clic en “Generar API Key”.

IMPORTANTE: Tu clave API tiene muchos privilegios, así que asegúrate de mantenerla en secreto. No la compartas en áreas de acceso público tales como GitHub, código del lado del cliente, etc.

Todas las solicitudes al API se deben realizar a través de HTTPS. Las llamadas realizadas a través de HTTP simple fallarán. Las solicitudes al API sin autenticación también fallarán.

En cada request al API, debes incluir el siguiente encabezado:

Authorization: Bearer CLAVE_API

Suscripción

Límite de consultas

Para garantizar un buen funcionamiento de la API así como del sistema en general para todos los usuarios, nuestra API cuenta con algunos limites de llamadas cada 5 minutos, también topado a un límite de llamadas al día.

Actualmente contamos con dos esquemas: usuarios no registrados y usuarios registrados. En el caso de usuarios no registrados, este esquema aplica para cualquier usuario que haga llamadas a la API usando solo el API Key obtenido en Bind ERP. Los límites que aplican para este esquema son los siguientes:

Hasta 150 consultas cada 5 minutos.
Máximo 5,000 consultas cada 24 horas.

En caso de que este limite de llamadas no sea suficiente para el uso que le das a la API, tienes la posibilidad de registrarte aquí. Una vez registrado será necesario que envíes un correo a [email protected] con los siguientes datos:

Uso que se le da a la API, explicando de trata el proyecto donde se está implementando.
Cantidad aproximada de llamadas por minuto a la API.
Funciones consultadas.
Correo con el cual registraron la cuenta en el portal de desarrolladores.

Una vez recibido el correo se asignará una suscripción a la cuenta la cual aumentará los límites de uso de siguiente manera:

Hasta 300 consultas cada 5 minutos.
Máximo 10,000 consultas cada 24 horas.

Está suscripción está incluida en plan contratado por lo que no te generará ningún costo extra.

Si aun así el límite de llamadas son insuficientes, será necesario ponerte en contacto con el área de desarrollo para realizar una cotización de acuerdo a tus necesidades.

Reportes

Otra de las ventajas que puedes obtener al utilizar nuestra API con una suscripción, es el hecho de poder tener a la mano los reportes de consultas realizadas. Dicha herramienta dará la posibilidad de ver reportes de consultas hechas en un determinado tiempo, las funcionas a las cuales se ha estado consultando, así como también cuantas de esas consultas han sido realizadas correctamente o con errores.

Podrás entrar al apartado de reportes lo verás disponible en el menú superior de la derecha, una vez que hayas iniciado sesión.

Obtén tu clave API de suscripción (API Key de suscripción)

Para autenticar tu suscripción cuando uses la API debes incluir tu clave secreta de API en la solicitud (API Key de suscripción).

Puedes generar tu clave API en tu Perfil de Usuario al cual puedes acceder dando clic a la opción "Mi Cuenta", que se encuentra en la parte superior derecha. Ahí encontrarás un apartado donde estará tu suscripción vigente, la cual contiene dos llaves las cuales podrás ver al dar clic al botón "Show". Puedes usar cualquiera de las dos, te funcionarán igual.

Si en algún momento regeneras las llaves, las anteriores dejarán de funcionar.

Uso de la suscripción

Una vez que tienes acceso a tu cuenta y se te ha asignado una suscripción, lo que sigue es hacer uso de ella en cada consulta que realices a la API para poder identificarte como usuario registrado y aumentar el límite de consultas, también para poder hacer el seguimiento en los reportes. Para hacerlo es necesario agregar una clave de suscripción API (API Key de suscripción) a través de un encabezado. Es muy importante aclarar que dicho API Key de suscripción no sustituye al API Key obtenido desde tu cuenta de Bind ERP, los dos deben ser enviados en cada consulta.

En cada consulta al API, debes incluir el siguiente encabezado:

Ocp-Apim-Subscription-Key: CLAVE_API_SUSCRIPCIÓN

Paginado

La API de Bind ERP utiliza la paginación para mejorar el rendimiento de las consultas. La paginación se aplica a los métodos que podrían devolver una gran colección de elementos. Cuando realices una solicitud al API paginada, la respuesta será un objeto JSON con metadatos de paginación, por ejemplo:

[ 
  { 
    "value": [ 
      { 
        "ID": "00000000-0000-0000-0000-000000000000", 
        "Code": "string", 
        "Title": "string", 
        "Description": "string" 
      } 
    ], 
    "nextLink": "http://localhost:63570/api/Products?$skip=50", 
    "count": 1000 
  } 
]

Donde:

count es el total de registros en la colección

nextLink es la URL para consultar la siguiente pagina del listado

Filtrado

La API de Bind ERP permite filtrar los resultados de los métodos que devuelven una colección de elementos. Cuando realices una solicitud al API filtrada, deberás incluir las opciones de filtrado en la variable $filter.

La variable $filter admite un conjunto de operaciones y funciones de filtro integradas que se pueden usar para obtener un subconjunto de recursos en una respuesta.

Por ejemplo:

https://api.bind.com.mx/api/Products?$filter=ID=guid'bbe2cc0c-3498-47cb-a556-d435eba5c0b4'

Los operadores admitidos en el lenguaje de expresiones se muestran en la siguiente tabla.

Filtrado de propiedades tipo Guid

Para filtrar propiedades de tipo Guid es importante que utilices la siguiente sintaxis:
guid’bbe2cc0c-3498-47cb-a556-d435eba5c0b4’
Por ejemplo: https://api.bind.com.mx/api/Products?$filter=ID=guid’bbe2cc0c-3498-47cb-a556-d435eba5c0b4’