Ir para o conteúdo

Outras plataformas via API

Com a API do BotCity Insights, você integra os dados do Orquestrador com outras plataformas.

A API disponibiliza os mesmos dados da seção Relatórios do BotCity Insights.

Referência da API

Sua operação de automação pode envolver outras plataformas de dados, sejam aplicações desenvolvidas pela sua empresa ou fornecidas por terceiros.

Com a API do BotCity Insights, você consome os dados reportados pelas automações e pode exibi-los em qualquer ferramenta de visualização de dashboards.

Começando agora?

Consulte a referência completa da API.

Procurando mais exemplos?

Veja os exemplos práticos com o Power BI.

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

Substitua a URL base

A URL https://sua-empresa.botcity.dev é apenas um exemplo. Nas requisições desta página, substitua pela URL do servidor dedicado da sua empresa, a mesma que você usa para acessar o Orquestrador.

Se você usa a versão Comunidade, a URL base é https://developers.botcity.dev.

Autenticação

O primeiro passo para usar a API do BotCity Insights é a autenticação.

A API usa um token de acesso, enviado no header de todas as requisições.

Para obter o token, faça uma requisição para a rota de login, enviando os valores de login e key no corpo da requisição.

Onde encontrar login e key

Os valores de login e key ficam na página Amb. Desenvolvedor do seu workspace no Orquestrador.

Exemplo

POST /api/v2/workspace/login

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

Com o token de acesso, você pode fazer as demais requisições para consumir os dados da API.

Veja abaixo exemplos de como consumir os dados dos relatórios com a API do BotCity Insights.

Tarefas

Esta rota retorna os dados das tarefas executadas no Orquestrador, os mesmos do relatório de Tarefas.

Faça a requisição enviando no header os valores de token e organization obtidos na autenticação.

Parâmetros:

Nome Descrição
page integer (optional)
Número da página a ser retornada. Valor padrão: 0
days integer (optional)
Quantidade de dias a considerar na busca. Valor padrão: 30

Exemplo

GET /api/v1/insights/tasks

curl --location 'https://sua-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
}

Automações

Esta rota retorna os dados das automações do Orquestrador, os mesmos do relatório de Automações.

Faça a requisição enviando no header os valores de token e organization obtidos na autenticação.

Parâmetros:

Nome Descrição
page integer (optional)
Número da página a ser retornada. 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 a ser buscada
filterBy integer (optional)
Quantidade de dias a considerar na busca. Valor padrão: 30

Exemplo

GET /api/v1/insights/automation

curl --location 'https://sua-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 rota retorna os dados dos Runners do Orquestrador, os mesmos do relatório de Runners.

Faça a requisição enviando no header os valores de token e organization obtidos na autenticação.

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 a ser buscado
filterBy integer (optional)
Quantidade de dias a considerar na busca. Valor padrão: 30

Exemplo

GET /api/v1/insights/runners

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