Exemplos utilizando Postman¶
Atenção
Nesta página são demonstradas apenas algumas das integrações possíveis com a API do BotCity Maestro.
Acesse a referência da API Completa para verificar todas as rotas disponíveis para comunicação.
Postman Collection¶
Caso você já tenha familiaridade utilizando a ferramenta Postman, pode utilizar a collection disponibilizada abaixo contendo alguns exemplos prontos.
Você pode utilizar esses exemplos como uma referência para criar suas próprias requisições.
Criando um environment no Postman¶
Para utilizar os exemplos da API no Postman, sugerimos que crie um novo environment com os parâmetros que serão utilizados nas requisições.
Após fazer o download do arquivo, basta importar no seu Postman como um novo environment.
Aqui está um exemplo de um environment criado no Postman:
Tabela de dados
| VARIABLE | TYPE | INITIAL VALUE |
|---|---|---|
| server | default | https://developers.botcity.dev |
| login | secret | Campo Login da página: Amb. Desenvolvedor |
| key | secret | Campo Key da página: Amb. Desenvolvedor |
| token | default | Gerado pela rota de Login |
| organization | default | Gerado pela rota de Login |
| automationLabel | default | Você pode informar o label de uma automação criada |
| taskId | default | Você pode informar o id de uma tarefa existente |
| logLabel | default | Você pode informar o label de um log criado |
| runnerId | default | Você pode informar o id de um Runner do workspace |
| botId | default | Você pode informar o id de um robô existente |
| botVersion | default | Você pode informar uma versão específica de um robô |
| credentialVault | default | Você pode informar o label de uma credencial existente |
| credentialKey | default | Você pode informar uma chave referente à uma credencial |
| errorId | default | Gerado pela rota de Errors |
| artifactId | default | Gerado pela rota de Result Files |
| datapoolLabel | default | Você pode informar o label de um Datapool existente |
Dica
As variáveis criadas são só uma forma de facilitar a execução das requisições. Você pode ajustar os valores com base nas informações do seu workspace.
Os valores para os parâmetros login e key podem ser encontrados na página Amb. de Desenvolvedor do BotCity Maestro.
Após essa etapa, basta importar no seu Postman a Collection que foi baixada na etapa anterior e vincular ao environment criado.
Autenticando¶
A primeira etapa necessária para utilizar a API do Orquestrador BotCity é a autenticação.
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.
No caso dos exemplos da collection do Postman, basta executar a requisição Login - Workspace para que os valores token e organization sejam gerados automaticamente.
Explorando a API¶
Feito! Após a etapa de autenticação o seu ambiente no Postman estará devidamente configurado para utilizar a API do Orquestrador BotCity.
Sinta-se à vontade para explorar os demais exemplos disponíveis na collection do Postman.
Info
Os valores token e organization gerados pela rota de login serão utilizados no header de todas as requisições.
Na seção contendo a API Completa você consegue encontrar mais detalhes sobre as rotas disponíveis e os parâmetros que podem ser utilizados.