Resumen
La Interfaz de Programación de Aplicaciones de MindBridge (“API”) le permite controlar los permisos y el acceso a varios aspectos de su arrendatario de MindBridge, incluidas las bibliotecas, organizaciones, compromisos y análisis.
Con la API, puede enviar archivos de manera segura desde su planificación de recursos empresariales (ERP) directamente al gestor de archivos, importar los datos en un análisis y ejecutar el análisis, todo desde fuera de la aplicación de MindBridge. Luego, solo ingrese a MindBridge para ver los resultados del análisis.
Aprenda sobre el uso general de la API de MindBridge.
Detalles de configuración
Debe ser un admin de aplicación para acceder a la página de la API.
¿Cómo obtengo acceso a la API?
Contacte a su admin de aplicación para solicitar acceso a la API de MindBridge.
¿Cómo funciona una API?
Una API permite que una aplicación se comunique con la aplicación de MindBridge a través de un conjunto de comandos claramente definidos, lo que permite un acceso seguro a los activos y procesos empresariales utilizando una interfaz REST.
Como se muestra en la imagen a continuación, usar una API es similar a hacer un pedido en un restaurante. Piense en los comandos de la API como pedir del menú de un restaurante: el menú define una lista de "platos" disponibles (es decir, programas o funciones), y cuando hace un pedido, la cocina (es decir, el servidor o la base de datos) prepara la comida (es decir, la solicitud) en la parte trasera, y luego se la envía cuando está lista.
En resumen, las API definen una lista de comandos. Cuando un ERP usa uno de esos comandos, MindBridge envía lo que se solicitó.
¿Qué es una arquitectura REST?
MindBridge utiliza una arquitectura API RESTful, que permite a los sistemas informáticos intercambiar información de manera segura a través de Internet utilizando el protocolo HTTPS. Las solicitudes realizadas a través de una API RESTful son sin estado, y cada solicitud contiene todos los datos necesarios para completar la solicitud con éxito.
¿Cuáles son los beneficios de usar una API?
Las API permiten:
- Ingesta de datos escalable y exportación de resultados utilizando automatización
- Una plataforma de análisis de datos unificada, independientemente de las necesidades de la industria u organización
- Acceso seguro y controlado a los datos de MindBridge, lo que crea nuevas oportunidades para el análisis y las ideas a escala
- La automatización de tareas complejas y repetitivas
¿Qué es un token de API de MindBridge?
Un token de API de MindBridge (un "token de API") es una cadena de caracteres que actúa como una clave para la API y se implementa como un token de autenticación portador. Se utiliza agregando el token al encabezado de cada solicitud HTTPS.
Este tipo de token es un token de autenticación criptográficamente seguro que incluye los permisos configurados que permiten a los clientes de la API acceder a los recursos de la API de MindBridge o "endpoints".
¿Cómo uso el token de API?
Para utilizar un token generado dentro de la plataforma de MindBridge, debe agregar lo siguiente al encabezado de cada solicitud HTTPS:
Authorization: Bearer {token} Accept: application/json
¿Cuánto tiempo duran los tokens de API?
El ciclo de vida del token es configurable por el admin de aplicación por cualquier período de tiempo, hasta un máximo de 2 años.
¿Qué pasa si mi token de API se ve comprometido?
Los tokens deben almacenarse en un lugar seguro y nunca deben compartirse. La seguridad de su token es primordial.
Si un token se ve comprometido, el admin de aplicación debe deshabilitar y volver a emitir el token de inmediato.
¿Qué es un endpoint?
Los endpoints son funciones expuestas de una API de aplicación con funcionalidad proporcionada por métodos HTTPS.
¿Qué es un método HTTPS?
Un método HTTPS representa la funcionalidad soportada por el protocolo HTTPS, como GET, POST, PUT, PATCH y DELETE.
Estos métodos esencialmente le permiten leer, escribir o eliminar bibliotecas, organizaciones, compromisos, análisis, usuarios y mucho más.
¿Cómo se generan los tokens de API?
Un admin de aplicación crea tokens de API en la sección de Admin de la aplicación, donde pueden aplicar el ciclo de vida y los permisos a cada token.
Aprenda cómo crear un token de API de MindBridge.
¿Quién puede acceder y usar la API?
Cualquiera que tenga un token válido puede usar la API.
Los admins de aplicación son responsables de gestionar los tokens de API y pueden otorgar acceso a la API a cualquier usuario dentro del compromiso.
¿Cómo uso la API?
Para usar la API:
- Un token de API debe ser generado por un admin de aplicación dentro de MindBridge.
- Una vez que tenga acceso al token de API, use el protocolo HTTPS para hacer una solicitud a un endpoint documentado en la API de MindBridge.
Las solicitudes se pueden hacer desde una variedad de fuentes, incluidos la mayoría de los lenguajes de programación o Postman.
¿Cuál es el formato para comunicarse con la API?
La API utiliza JSON para todas las solicitudes y respuestas, con la excepción de los archivos de datos, que se pueden importar en cualquier formato compatible dentro de la aplicación.
¿Qué formatos de archivo se aceptan a través de la API?
Entrante
Todos los formatos de archivo actualmente soportados por el gestor de archivos serán aceptados, como .xlsx, .csv, .xlsb y más.
Saliente
Solo resultados JSON.
¿Qué archivos puedo enviar o recibir a través de la API?
Entrante
Todos los archivos actualmente soportados por la plataforma de MindBridge se pueden enviar a través de la API.
Los archivos se pueden asignar a cualquiera de las fuentes dentro de un análisis, como la ranura de "detalle del libro mayor".
Saliente
La API soportará resultados de análisis paginados y consultables, indexados por transacciones o entradas. Los datos disponibles son equivalentes a la tabla de datos en la plataforma de MindBridge.
¿Dónde puedo encontrar documentación más detallada?
Los siguientes artículos proporcionan detalles adicionales y orientación sobre la API de MindBridge.
Para documentación técnica, abra el menú de Acciones en el lado derecho de la pestaña de la API, luego seleccione Ver referencia de la API. Será llevado al documento de referencia de la API.
Para ver una lista continua de cambios realizados en la API, abra el menú de Acciones en el lado derecho de la pestaña de la API, luego seleccione Ver registro de cambios de la API. Será llevado al registro de cambios de la API.
Para más información o contáctenos en info@mindbridge.ai.
Como usuario de la API, ¿dónde puedo comenzar?
- Lea la documentación de la API de MindBridge
- Genere o obtenga acceso a un token de API
- Pruebe los endpoints y acciones deseados de la API
¿Algo más en su mente? Chatee con nosotros o envíe una solicitud para obtener más ayuda.