Introducción

Esta sección de la documentación explica como utilizar nuestro API para realizar integraciones de desarrollos a la medida con su información en InterFuerza.

La estructura de información es JSON, el cual es el más utilizado en los API de hoy. Puede conocer más sobre JSON aquí.

Token de Autenticación

El Token de autenticación de peticiones hechas al API es la que se obtiene desde la seccion de Integraciones:

Dentro de las integraciones se debe acceder en Conectar:

La misma se mostrara de forma segura el Token de Autenticación:

Podrá Copiar el Token, Mostrar el Token o Regenerar el Token para regenerar todas las integraciones.

Si Regenera el Token debe estar claro que deberá actualizar sus integraciones realizadas pues el API comenzara a denegar cualquier integración que no este utilizando el nuevo Token.

 

Comunicación con el API

Para realizar las comunicaciones con el API la misma es con HTTPS. Toda las peticiones deben ser enviadas a la dirección:

https://app.interfuerza.com/api/

La misma debe llevar el siguiente encabezado o HTTP Header:

X-IFX-Token: <TokenString>

Donde <TokenString> es el token obtenido con anterioridad.

Clases y Acciones

Nuestro API utiliza dos variables enviadas en el contenido POST, a continuación la descripción de cada una:

Clases son definidos por la variable: class

 class Descripción
GET Obtener información.
PUT Guardar nueva información.
UPDATE Actualizar información existente.
DELETE Eliminar información.

Acciones son definidas por la variable:  action

La acción define la acción a ejecutar según la opción, algunos ejemplos:

 class  action Descripción
GET customers Obtiene el listado de todos los clientes.
PUT customer Crea un nuevo cliente.
UPDATE customer Actualiza una cliente.
DELETE customer Elimina un cliente.

Un ejemplo del JSON a enviar para consultar todos los clientes seria:

 {"class":"GET","action":"customers"} 

En PHP CURL seria:

Ver Código

Recuerde que remplazar el $access_token con el Token de autenticación de su empresa.

Errores

Nuestro API utiliza los errores de HTTP Status Code para reportar los errores que se encuentran en alguna ejecución. Por ejemplo se reporta un error 400 Bad Request para reportar una acción o clase desconocida por el api.

Cualquier error sera reportado con los códigos 4xx y podran ser capturados según sea acorde.

 

¿Fue de ayuda este artículo?