Ejemplos usando Postman¶
Atención
En esta página se muestran solo algunas de las integraciones posibles con la API de BotCity Maestro.
Acceda a la referencia de la API Completa para verificar todas las rutas disponibles para la comunicación.
Colección do Postman¶
Si ya está familiarizado con la herramienta Postman, puede utilizar la colección proporcionada a continuación que contiene algunos ejemplos listos para usar.
Puede utilizar estos ejemplos como referencia para crear sus propias solicitudes.
Creación de un entorno en Postman¶
Para utilizar los ejemplos de la API en Postman, le sugerimos que cree un nuevo environment con los parámetros que se utilizarán en las solicitudes.
Después de descargar el archivo, simplemente impórtelo en su Postman como un nuevo environment.
Aquí hay un ejemplo de un environment creado en Postman:
Tabela de dados
| VARIABLE | TYPE | INITIAL VALUE |
|---|---|---|
| server | default | https://developers.botcity.dev |
| login | secret | Campo Login de la página: Entorno de Desarrollo |
| key | secret | Campo Key de la página: Entorno de Desarrollo |
| token | default | Generado por la ruta de Login |
| organization | default | Generado por la ruta de Login |
| automationLabel | default | Puede informar la etiqueta de una automatización creada |
| taskId | default | Puede informar el id de una tarea existente |
| logLabel | default | Puede informar la etiqueta de un log creado |
| runnerId | default | Puede informar el id de un Runner del espacio de trabajo |
| botId | default | Puede informar el id de un robot existente |
| botVersion | default | Puede informar una versión específica de un robot |
| credentialVault | default | Puede informar la etiqueta de una credencial existente |
| credentialKey | default | Puede informar una clave relacionada con una credencial |
| errorId | default | Generado por la ruta de Errors |
| artifactId | default | Generado por la ruta de Result Files |
| datapoolLabel | default | Puede informar la etiqueta de un Datapool existente |
Consejo
Las variables creadas son solo una forma de facilitar la ejecución de las solicitudes. Puede ajustar los valores en función de la información en su espacio de trabajo.
Los valores para los parámetros login y key se pueden encontrar en la página Entorno de Desarrollo de BotCity Maestro.
Después de este paso, simplemente importe la Colección que se descargó en el paso anterior y vincúlela al environment creado.
Autenticación¶
El primer paso necesario para utilizar la API de Orquestrador BotCity es la autenticación.
Para obtener el token de autenticación, simplemente haga una solicitud a la ruta de inicio de sesión, pasando la información de login y key en el cuerpo de la solicitud.
En el caso de los ejemplos de la colección de Postman, simplemente ejecute la solicitud Login - Workspace para que los valores token y organization se generen automáticamente.
Explorando la API¶
¡Hecho! Después del paso de autenticación, su entorno en Postman estará debidamente configurado para utilizar la API del Orquestrador BotCity.
Siéntase libre de explorar los demás ejemplos disponibles en la colección de Postman.
Info
Los valores token y organization generados por la ruta de inicio de sesión se utilizarán en el header de todas las solicitudes.
En la sección que contiene la API Completa puede encontrar más detalles sobre las rutas disponibles y los parámetros que se pueden utilizar.