Saltar a contenido

Otras plataformas a través de API

Con la API de BotCity Insights, usted integra los datos del Orquestador con otras plataformas.

La API ofrece los mismos datos de la sección Informes de BotCity Insights.

Referencia de la API

Su operación de automatización puede involucrar otras plataformas de datos, ya sean aplicaciones desarrolladas por su empresa o proporcionadas por terceros.

Con la API de BotCity Insights, usted consume los datos reportados por las automatizaciones y puede mostrarlos en cualquier herramienta de visualización de dashboards.

¿Empezando?

Consulte la referencia completa de la API.

¿Busca más ejemplos?

Vea los ejemplos prácticos con Power BI.

URL BASE
https://su-empresa.botcity.dev

Reemplace la URL base

La URL https://su-empresa.botcity.dev es solo un ejemplo. En las solicitudes de esta página, reemplácela por la URL del servidor dedicado de su empresa, la misma que usa para acceder al Orquestador.

Si usa la versión Comunidad, la URL base es https://developers.botcity.dev.

Autenticación

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

La API usa un token de acceso, enviado en el header de todas las solicitudes.

Para obtener el token, haga una solicitud a la ruta de login, enviando los valores de login y key en el cuerpo de la solicitud.

Dónde encontrar login y key

Los valores de login y key están en la página Entorno de Desarrollo de su workspace en el Orquestador.

Ejemplo

POST /api/v2/workspace/login

curl --location 'https://su-empresa.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>"
}

Con el token de acceso, puede hacer las demás solicitudes para consumir los datos de la API.

Vea a continuación ejemplos de cómo consumir los datos de los informes con la API de BotCity Insights.

Tareas

Esta ruta devuelve los datos de las tareas ejecutadas en el Orquestador, los mismos del informe de Tareas.

Haga la solicitud enviando en el header los valores de token y organization obtenidos en la autenticación.

Parámetros:

Nombre Descripción
page integer (opcional)
Número de la página a devolver. Valor predeterminado: 0
days integer (opcional)
Cantidad de días a considerar en la búsqueda. Valor predeterminado: 30

Ejemplo

GET /api/v1/insights/tasks

curl --location 'https://su-empresa.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

Esta ruta devuelve los datos de las automatizaciones del Orquestador, los mismos del informe de Automatizaciones.

Haga la solicitud enviando en el header los valores de token y organization obtenidos en la autenticación.

Parámetros:

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

Ejemplo

GET /api/v1/insights/automation

curl --location 'https://su-empresa.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

Esta ruta devuelve los datos de los Runners del Orquestador, los mismos del informe de Runners.

Haga la solicitud enviando en el header los valores de token y organization obtenidos en la autenticación.

Parámetros:

Nombre Descripción
sort string,string (opcional)
Orden de los resultados. Valor predeterminado: tasks,desc.
Opciones de campo: _id, tasks, items, itemsErrorCount, utilizationRate.
Opciones de orden: asc, desc.
runner string (opcional)
Identificador del Runner a buscar
filterBy integer (opcional)
Cantidad de días a considerar en la búsqueda. Valor predeterminado: 30

Ejemplo

GET /api/v1/insights/runners

curl --location 'https://su-empresa.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
    },
    ...
]