Introducción a InterFuerza Api
Inicio
Esta sección de la documentación explica cómo 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 en la actualidad. Puede conocer más sobre JSON ingresando aquí https://www.json.org/json-en.html
Token de Autenticación
Para acceder a las funciones de API, debe dar click en el menú de Configuración desde su cuenta de InterFuerza, y seleccionar la opción Apps, como lo muestra la imagen:
Al ingresar a la pantalla de Apps de InterFuerza, busque la opción de InterFuerza Api, y de clic en Configurar:
Al dar clic en Configurar, ingresará a nueva ventana donde accederá a toda la información necesaria para llevar a cabo sus integraciones:
El Api de InterFuerza es compatible con la version 1_1 de HTTP.
Control de accesos por IP
Token
Aquí se genera el token necesario para llevar a cabo sus integraciones. Inclusive, podrá regenerar su Token de ser necesario. Si regenera el Token, debe estar claro que deberá actualizar sus integraciones realizadas. Puesto que el API comenzará a denegar cualquier integración que no esté utilizando el nuevo Token.
Control de accesos por IP
Es de carácter obligatorio agregar en este apartado todos los IPs desde los cuales, se recibirán todos los llamados de API. Este paso es fundamental para lograr un buen funcionamiento.
Documentación
Acceda a todos las guías de InterFuerza API para llevar a cabo de forma exitosa sus integraciones.
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:
Donde es el token obtenido con anterioridad.
Clases y Acciones
Nuestro API utiliza dos variables enviadas en el contenido POST. A continuación detallamos la descripción de cada una:
Clases son definidos por la variable class:
| class | Descripción |
|---|---|
| GET Obtener información. | 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 | customers | Crea un nuevo cliente. |
| UPDATE | customers | Actualiza un 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 sería:
<?
$url = "https://app.interfuerza.com/api/" ;
$post_json = json_encode(array("class"=>"GET", "action"=>"quotes")) ;
$curl = curl_init($url);
curl_setopt_array($curl, array( CURLOPT_RETURNTRANSFER => 1, CURLOPT_POST => 0, CURLOPT_SSL_VERIFYPEER => 0, CURLOPT_HTTPHEADER => array("X-IFX-Token: ".$access_token, 'Content-Type: application/json', 'Content-Length: ' . strlen($post_json)), CURLOPT_POSTFIELDS => $post_json ));
$response = curl_exec($curl);
if(!$response){
die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
}
curl_close($curl);
print_r(json_decode($response, true)) ;
?>
Recuerde que remplazar el $access_token con el Token de autenticación de su empresa.
Errores
Nuestro API utiliza los errores de HTTP Status Codepara 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 será reportado con los códigos 4xx y podrán ser capturados según sea acorde.
NOTA
El uso del Api de InterFuerza, debe ser llevarse a cabo bajo los términos y condiciones de InterFuerza. El otorgar acceso a esta función desde su cuenta a sus usuarios, queda bajo su responsabilidad y la de los usuarios con acceso a Apps.
Puede contactarnos a través de nuestro chat de atención al cliente para resolver cualquier duda que surja durante este proceso.
Rate Limit
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.
Updated about 1 year ago