Introducción a API v4
Inicio
En InterFuerza actualmente contamos con dos (3) versiones de API disponibles, que han permitido a cientos de comercios conectar sus aplicaciones propias o de terceros a su plataforma de gestión. Esto ha permitido que los negocios estén 100% integrados y obtengan información importante en tiempo real. Actualmente tenemos disponibles:
| Versión | Descripción |
|---|---|
| 1.0 (2016 - Versión Descontinuada) | Esta es la versión inicial del API, el cual ofrece la mayoría de las funciones. Pero su control de seguridad esta limitado a 1 solo Token y lista de accesos por IPs. |
| 3.0 (2020 - Versión Estable) | Esta versión permite todas las últimas funcionalidades y controles de seguridad, permitiendo controlar el acceso por múltiples Tokens, que a su vez, controla que funciones especificas pueden utilizarse en el API, y desde qué lista de IPs es permitido que el Token pueda consumir el API. No cuenta las funcionalidades y cambios del V4. |
| 4.0 (2022 - Versión Reciente) | Esta versión permite todas las últimas funcionalidades y controles de seguridad, permitiendo controlar el acceso por múltiples Tokens, que a su vez, controla que funciones especificas pueden utilizarse en el API, y desde qué lista de IPs es permitido que el Token pueda consumir el API. |
En esta documentación vamos a explicar el uso de la versión 4.
Cómo habilito el API
Para habilitar la versión 3 en su cuenta, debe acceder al módulo de configuración, buscar la opción Apps en el menú, y finalmente elegir InterFuerza API:
Al dar click en “Configurar” accederá a la siguiente pantalla que le mostrará inicialmente, los datos de la versión actual en uso:
Adicional, hallará la opción de “Actualizar a Versión 3.0.5″. Esta versión le permitirá acceder a las nuevas funcionalidades de seguridad.
Es importante tener presente que si realiza esta actualización, las integraciones que utilizan el API V1.0.5 dejarán de funcionar, y enviará el error de Versión not Installed.
Una vez actualizada la versión, se mostrará en su pantalla, el nuevo administrador del Api de Interfuerza:
Compatibilidad de V4 con V3
La autenticación y actualización a API V3 le da acceso a utilizar ambas versiones con el mismo token. Solo funcionalidades exclusivas de V4 estarán bajo el url de la versión 4.
Creando un nuevo token
Para crear un nuevo token solo debe presionar en el botón “Agregar Token” desde el administrador de Api. Al dar clic, se abrirá la siguiente pantalla:
Aquí, contará con las siguientes opciones:
| Opción | Descripción |
|---|---|
| TOKEN | Este es el token generado de autenticación. El token no estará disponible hasta que guarde la pantalla. |
| Nombre | Este es el nombre con el que se conoce el token. |
| Descripción | Esta es una breve descripción del token. |
| Ips | Estos son el listado de IP’s de los cuales se consumirá el token. |
| Permisos | Estos son las funcionalidades que el token tiene permitido usar del API. Sino existe ninguna, el Token no funcionará. |
Una vez creado el token, se podrá observar en el listado de “Tokens Activos”:
Acciones en los tokens
Se pueden llevar a cabo diferentes acciones en cada token. Para poder ver, editar o inactivar un token, presione el botón de “Acciones” en el token que desea aplicar la acción:
Ver Token
Le permite ver la información completa del Token. Desde los ips, permisos y información de creación y actualización. Esto con el fin de tener mayor control.
Editar
El editar Token, le permite cambiar los parámetros de seguridad del mismo. Es importante notar que los cambios se verán reflejados instantáneamente al guardar los cambios.
Inactivar
El inactivar permite dar de baja el acceso completo al Token.
Utilizando el API y Token
Los token se usan de la misma forma que en la versión original, lo único que cambia es el url a consumir:
https://app.interfuerza.com/api/v4/
La opción de Enviar Token en el llamado es la misma forma que la anterior:
X-IFX-Token:
Todas las opciones del API y su documentación están disponible en esta versión igual que la anterior.
Si tiene dudas sobre cómo actualizar o usar las funciones de API de InterFuerza, por favor contactarnos a través de nuestro chat online de atención al cliente. Nuestro equipo estará atento para asistirle.
RateLimit
El API de InterFuerza cuenta con un RateLimit de un máximo de 20 peticiones por cada 10 segundos. En caso de llegar a este limite el mismo bloqueara el IP por 1 Hora.
Nuevos cambios en V4
El API V4 cuenta con todas las funciones ya existentes de V3 con los siguientes cambios:
Cambios de Funcionalidades
A continuación los cambios del V4 que no son iguales al V3:
En los siguientes endpoint se agregaron campos:
| Endpoint | Changes | Options |
|---|---|---|
| GET/customer | Campos nuevos Created y Updated | Filtrables |
| GET/customer | Campos nuevos Created y Updated | |
| GET/providers | Campos nuevos Updated | Filtrable |
| GET/provider | Campos nuevos Updated | |
| GET/products | Campos nuevos Created y Updated. | Filtrable |
Nuevas Funcionalidades
A continuación las nuevas funcionalidades que solo están en la V4:
Se ha agrego nuevos endpoints (GET/PUT):
- Transferencias
- Ajuste de Inventarios
- Ordenes de Compra a Proveedores
- Notas de Crédito a Clientes
- Notas de Crédito a Proveedores
Función de Filtros
Se agrego la opción de filtros en los siguientes endpoints:
GET/providers
Updated about 1 year ago