¿Qué es la API Pública de Agicap?
La API Pública te permite a ti y a tus integradores o socios desarrollar integraciones técnicas con Agicap. Facilita la automatización del intercambio de datos entre aplicaciones, permitiendo una integración fluida con tus herramientas existentes.
¿Por qué usar la API Pública?
Aquí tienes algunos beneficios inmediatos de usar la API Pública:
Seguridad mejorada: Nuestras APIs están protegidas por un flujo de credenciales de cliente. Cada organización debe generar sus propias credenciales desde la aplicación de Agicap antes de comenzar a usar la API. Es más seguro ya que cada servicio utiliza credenciales únicas.
Mayor rendimiento: Nuestra solución puede manejar hasta 4000 solicitudes por segundo, permitiendo que tus integraciones escalen sin temer interrupciones en la API.
Consistencia: Hemos definido directrices para la API de Agicap para asegurar que todas nuestras APIs expuestas tengan implementaciones estandarizadas.
A largo plazo, la API Pública permitirá casos de uso que no eran posibles con nuestra anterior Open API:
Monitoreo integral: Monitorea el consumo de la API por parte de los clientes configurados y sus puntos finales.
Capacidades de suplantación de usuario: Permite llamadas a la API como un usuario dentro de un sistema de credenciales de cliente, habilitando tareas automatizadas como asignar un usuario a una entidad cuando se añaden a tu Directorio Activo.
Cómo comenzar con la API Pública
1. Accede a la documentación de la API Pública
La documentación de la API Pública está disponible en https://api.agicap.com/. Aquí encontrarás información detallada sobre cómo realizar solicitudes a la API.
2. Genera tus credenciales de API
Solo los usuarios Admin de la organización pueden generar claves de API desde los Parámetros Avanzados en la aplicación de Agicap. Otros usuarios pueden ver las credenciales existentes pero no pueden generar nuevas ni eliminar las existentes.
Para generar credenciales de API:
Navega a Parámetros Avanzados en tu cuenta de Agicap.
Selecciona Configuración de API.
Haz clic en Generar nuevas credenciales.
Nota: Por razones de seguridad, el secreto del cliente solo se mostrará una vez al generarse. Asegúrate de mantenerlo seguro.
👍 Se recomienda usar un conjunto único de claves de API para cada herramienta, integrador o socio.
3. Autentica tus solicitudes de API
La autenticación se gestiona a través de claves de API y requiere un token de acceso temporal. Puedes obtener este token usando la solicitud de autenticación y tus claves de API.
Cada solicitud debe incluir este token de acceso.
4. Realizar solicitudes de API
Las solicitudes de API están organizadas en dominios y productos:
Dominios de API: Se refieren al contexto general del negocio.
Productos de API: Se refieren a objetos específicos o conjuntos de objetos relacionados con los que interactuar.
La mayoría de las solicitudes se realizan para recuperar datos de una organización o entidad dada.
El ID de la organización se puede obtener desde la página de configuración de la API.
El ID de la entidad se puede obtener a través de la solicitud listar entidades.
Puedes:
Recuperar datos de Agicap para actualizar tus herramientas.
Enviar, actualizar o eliminar datos en Agicap.
5. Explora los puntos finales de la API
Visita https://api.agicap.com/apis para ver los puntos finales disponibles y las acciones que puedes realizar a través de la API Pública.
💡 Consejos
Mantén tus credenciales seguras: Tu secreto de cliente solo se muestra una vez. Guárdalo de manera segura.
Usa credenciales únicas: Genera claves de API separadas para cada servicio o integración para una mejor seguridad.
Consulta la documentación: Siempre consulta https://api.agicap.com/ para obtener la información más actualizada.
Preguntas y Respuestas ❓
¿Cuál es la diferencia entre la API Pública y la Open API?
Ten cuidado de no confundir Open API y API Pública; son dos cosas diferentes:
Open API: Te permite crear conexiones de Negocios y Bancarias (principalmente a través de AFT) y es gestionada por el equipo de Integración de Datos. Los puntos finales comienzan con
openapi.agicap.com.API Pública: Te permite enviar y recuperar diversos datos de Agicap de manera segura y eficiente. Los puntos finales comienzan con
api.agicap.com.
La API Pública ofrece seguridad mejorada, rendimiento y nuevas capacidades no disponibles con la Open API.
¿Cómo migro de la Open API a la API Pública?
Nuestro objetivo es trasladar todos los casos de uso a la API Pública. Contactaremos a los clientes que aún usen la Open API una vez que todos los casos de uso estén cubiertos en la API Pública.
¿Puedo obtener asistencia para configurar la API Pública?
Se espera que los clientes sean autónomos al configurar la API Pública siguiendo las instrucciones en el sitio público https://api.agicap.com/. Si necesitas más ayuda, por favor háznoslo saber.