Ir para o conteúdo

Outras plataformas via API

O BotCity Insights também oferece a possibilidade de integrar os dados do Orquestrador com outras plataformas via API.

Os dados que podem ser consumidos via API são os dados disponíveis na seção de Relatórios do BotCity Insights.

Referência da API

Em muitos casos, a sua iniciativa de RPA pode envolver outras plataformas de dados, sejam aplicações customizadas desenvolvidas pela sua empresa, ou fornecidas por terceiros.

Utilizando a API do BotCity Insights, você conseguirá consumir os dados e informações que são reportados pelos processos de automação, podendo realizar integrações para exibir os dados da operação em qualquer ferramenta de visualização de dashboards.

Começando agora?

Dê uma olhada na referência completa da API.

Procurando mais exemplos?

Consulte a seção que possui exemplos práticos utilizando o Power BI.

BASE URL
https://developers.botcity.dev

Autenticação

A primeira etapa necessária para utilizar a API do BotCity Insights é a autenticação.

A API do BotCity Insights utiliza um token de autenticação que é enviado no header de todas as requisições.

Para obter o token de autenticação, basta fazer uma requisição para a rota de login, passando as informações do login e key no corpo da requisição.

Dica

As informações do login e key podem ser obtidas na página Amb. Desenvolvedor. do seu workspace no Orquestrador.

Exemplo

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>"
}

Após realizar a etapa de autenticação para obter o token de acesso, agora você poderá utilizá-lo nas demais requisições para consumir os dados da API.

Abaixo você encontra alguns exemplos práticos de como utilizar a API do BotCity Insights para consumir os dados dos relatórios.

Tarefas

A API do BotCity Insights possui uma rota para consumir os dados referentes às tarefas que foram executadas no Orquestrador.

Basta fazer uma requisição para a rota das tarefas, passando no header as informações do token e organization obtidas anteriormente.

Parâmetros:

Nome Descrição
page integer (optional)
Número da página para pesquisar. Valor padrão: 0
days integer (optional)
Filtro de dias para pesquisar. Valor padrão: 30

Exemplo

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
}

Automações

A API do BotCity Insights possui uma rota para consumir os dados referentes às automações existentes no Orquestrador.

Basta fazer uma requisição para a rota das automações, passando no header as informações do token e organization obtidas anteriormente.

Parâmetros:

Nome Descrição
page integer (optional)
Número da página para pesquisar. Valor padrão: 0
sort string,string (optional)
Ordenação dos resultados. Valor padrão: label,asc.
Opções de campo: label, date, repositoryLabel, taskCount, sumItems, sumItemsError.
Opções de ordem: asc, desc.
automation string (optional)
Label da automação para pesquisar
filterBy integer (optional)
Filtro de dias para pesquisar. Valor padrão: 30

Exemplo

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

A API do BotCity Insights possui uma rota para consumir os dados referentes aos Runners existentes no Orquestrador.

Basta fazer uma requisição para a rota dos Runners, passando no header as informações do token e organization obtidas anteriormente.

Parâmetros:

Nome Descrição
sort string,string (optional)
Ordenação dos resultados. Valor padrão: tasks,desc.
Opções de campo: _id, tasks, items, itemsErrorCount, utilizationRate.
Opções de ordem: asc, desc.
runner string (optional)
Identificador do Runner para pesquisar
filterBy integer (optional)
Filtro de dias para pesquisar. Valor padrão: 30

Exemplo

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
    },
    ...
]