Saltar a contenido

Otras plataformas a través de API

BotCity Insights también ofrece la posibilidad de integrar datos de Orchestration con otras plataformas a través de API.

Los datos que se pueden consumir a través de la API son los datos disponibles en la sección de Informes de BotCity Insights.

Referencia de la API

En muchos casos, su iniciativa de RPA puede involucrar otras plataformas de datos, ya sea aplicaciones personalizadas desarrolladas por su empresa o proporcionadas por terceros.

Al utilizar la API de BotCity Insights, podrá consumir los datos e información reportados por los procesos de automatización, lo que le permitirá integrar y mostrar datos de operación en cualquier herramienta de visualización de tableros.

¿Empezando?

Eche un vistazo a la referencia completa de la API.

¿Busca más ejemplos?

Consulte la sección con ejemplos prácticos utilizando Power BI.

URL BASE
https://developers.botcity.dev

Autenticación

El primer paso para utilizar la API de BotCity Insights es la autenticación.

La API de BotCity Insights utiliza un token de autenticación que se envía en el header de todas las solicitudes.

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.

Consejo

La información de login y key se puede obtener en la página de Entorno de Desarrollo de su espacio de trabajo en lo Orquestador.

Ejemplo

POST /api/v2/workspace/login

curl --location 'https://developers.botcity.dev/api/v2/workspace/login' \
--header 'Content-Type: application/json' \
--data '{
    "login": "<WORKSPACE_LOGIN>",
    "key": "<WORKSPACE_KEY>"
}'
Response 
{
    "accessToken": "<YOUR_ACCESS_TOKEN>",
    "organizationLabel": "<YOUR_ORGANIZATION_LABEL>"
}

Después de completar el paso de autenticación para obtener el token de acceso, ahora puede usarlo en las solicitudes posteriores para consumir los datos de la API.

A continuación, se muestran algunos ejemplos prácticos de cómo utilizar la API de BotCity Insights para consumir datos de informes.

Tareas

La API de BotCity Insights tiene una ruta para consumir datos relacionados con las tareas que se han ejecutado en lo Orquestador.

Simplemente haga una solicitud a la ruta de tareas, pasando la información de token y organization en el header, obtenida anteriormente.

Parámetros:

Nombre Descripción
page integer (opcional)
Número de página a buscar. Valor predeterminado: 0
days integer (opcional)
Filtro de días a buscar. Valor predeterminado: 30

Ejemplo

GET /api/v1/insights/tasks

curl --location 'https://developers.botcity.dev/api/v1/insights/tasks?page=0&days=30' \
--header 'token: <YOUR_ACCESS_TOKEN>' \
--header 'organization: <YOUR_ORGANIZATION_LABEL>'
Response 
{
    "content": [
        {
            "id": 17296058,
            "state": "START",
            "finishStatus": null,
            "activityLabel": "supplierHomologation",
            "repositoryLabel": "DEFAULT",
            "machineId": null,
            "dateLastModified": null,
            "dateCreation": "2024-02-09T20:02:40.032+00:00",
            "dateStartRunning": null,
            "processedItems": 0,
            "failedItems": 0,
            "totalItems": 0
        },
        ...
    ],
    "number": 0,
    "size": 20,
    "totalElements": 1,
    "pageable": {
        "pageNumber": 0,
        "pageSize": 20,
        "sort": {
            "sorted": false,
            "empty": true,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalPages": 1,
    "sort": {
        "sorted": false,
        "empty": true,
        "unsorted": true
    },
    "first": true,
    "numberOfElements": 20,
    "empty": false
}

Automatizaciones

La API de BotCity Insights tiene una ruta para consumir datos relacionados con las automatizaciones existentes en lo Orquestador.

Simplemente haga una solicitud a la ruta de automatizaciones, pasando la información de token y organization en el header, obtenida anteriormente.

Parámetros:

Nombre Descripción
page integer (opcional)
Número de página a buscar. Valor predeterminado: 0
sort string,string (opcional)
Orden de resultados. Valor predeterminado: label,asc.
Opciones de campo: label, date, repositoryLabel, taskCount, sumItems, sumItemsError.
Opciones de orden: asc, desc.
automation string (opcional)
Etiqueta de automatización a buscar
filterBy integer (opcional)
Filtro de días a buscar. Valor predeterminado: 30

Ejemplo

GET /api/v1/insights/automation

curl --location 'https://developers.botcity.dev/api/v1/insights/automation?page=0&sort=label,asc&filterBy=30' \
--header 'token: <YOUR_ACCESS_TOKEN>' \
--header 'organization: <YOUR_ORGANIZATION_LABEL>'
Response 
{
    "content": [
        {
            "label": "supplierHomologation",
            "name": "Supplier Homologation",
            "machineId": null,
            "description": "Supplier Homologation Automation for SAP",
            "organizationLabel": "demo",
            "repositoryLabel": "DEFAULT",
            "date": "2024-02-23T23:00:02.513",
            "taskCount": 0,
            "sumItems": 0.0,
            "sumItemsError": 0.0,
            "sumItemsProcessed": 0.0,
            "uptimeRate": 0.0,
            "downtimeRate": 0.0,
            "successRate": 0.0,
            "roi": 0.0,
            "fte": 0.0,
            "savings": 0.0
        },
        ...
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 20,
        "sort": {
            "sorted": false,
            "empty": true,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "totalPages": 1,
    "totalElements": 1,
    "last": true,
    "size": 20,
    "number": 0,
    "sort": {
        "sorted": false,
        "empty": true,
        "unsorted": true
    },
    "numberOfElements": 20,
    "first": true,
    "empty": false
}

Runners

La API de BotCity Insights tiene una ruta para consumir datos relacionados con los Runners existentes en lo Orquestador.

Simplemente haga una solicitud a la ruta de Runners, pasando la información de token y organization en el header, obtenida anteriormente.

Parámetros:

Nombre Descripción
sort string,string (opcional)
Orden de resultados. Valor predeterminado: tasks,desc.
Opciones de campo: _id, tasks, items, itemsErrorCount, utilizationRate.
Opciones de orden: asc, desc.
runner string (opcional)
Identificador de Runner a buscar
filterBy integer (opcional)
Filtro de días a buscar. Valor predeterminado: 30

Ejemplo

GET /api/v1/insights/runners

curl --location 'https://developers.botcity.dev/api/v1/insights/runners?sort=tasks,desc&filterBy=30' \
--header 'token: <YOUR_ACCESS_TOKEN>' \
--header 'organization: <YOUR_ORGANIZATION_LABEL>'
Response 
[
    {
        "id": "vm01",
        "idMachine": "vm01",
        "log": "teste",
        "remoteAccess": "",
        "status": "created",
        "name": "vm01",
        "organization": "demo",
        "automations": [
            "supplierHomologation",
            ...
        ],
        "tasks": 0,
        "items": 0,
        "itemsErrorCount": 0,
        "utilizationRate": 0
    },
    ...
]