Os parâmetros [P] de configuração deste Driver não são utilizados. Todas as configurações são executadas na janela de configurações, mostrada na figura a seguir.
Aba RESTAPIClient
As opções disponíveis na aba RESTAPIClient estão descritas na tabela a seguir.
Opções disponíveis na aba RESTAPIClient
Opção |
Descrição |
|---|---|
API URL |
Caminho da API (Application Programming Interface ou Interface de Programação de Aplicações), composta pelo protocolo, HTTP ou HTTPS, pelo domínio, como por exemplo "https://api.exemplo.com", e, quando necessário, por uma porta TCP/IP, como por exemplo "https://api.exemplo.com:8080", definida antes das rotas específicas que identificam os recursos de uma API |
Auth |
Selecione esta aba para configurar a autenticação de uma API. Para mais informações, consulte a tabela Opções disponíveis na aba Auth |
Routes |
Selecione esta aba para configurar as rotas específicas de uma API. Para mais informações, consulte a tabela Opções disponíveis na aba Routes |
Templates |
Selecione esta aba para configurar os modelos no formato JSON de requisição e resposta de uma API. Para mais informações, consulte a tabela Opções disponíveis na aba Templates |
Aba Auth
As opções disponíveis na aba Auth estão descritas na tabela a seguir.
Opções disponíveis na aba Auth
Opção |
Descrição |
|---|---|
Define o tipo de autenticação utilizado por este Driver. As opções disponíveis são No Auth, Basic Auth ou Bearer Token |
|
Token Type |
Define o tipo de Bearer Token. Esta opção só é habilitada quando a opção Auth Type está configurada como Bearer Token. As opções disponíveis são Expiring (From Endpoint), Non-Expiring (From Endpoint) ou Non-Expiring (Provided) |
Username |
Define o nome de um usuário. Disponível apenas para autenticações dos tipos Basic Auth ou Bearer Token dos tipos Expiring (From Endpoint) ou Non-Expiring (From Endpoint) |
Password |
Define a senha de um usuário. Disponível apenas para autenticações dos tipos Basic Auth ou Bearer Token dos tipos Expiring (From Endpoint) ou Non-Expiring (From Endpoint) |
Endpoint |
Define o endpoint usado para obter um Bearer Token, como por exemplo "/auth/token". Disponível apenas para a autenticação do tipo Bearer Token dos tipos Expiring (From Endpoint) ou Non-Expiring (From Endpoint) |
Token Key |
Define uma chave no arquivo do tipo JSON de resposta do endpoint que contém um Bearer Token, como por exemplo "access_token". Disponível apenas para a autenticação do tipo Bearer Token dos tipos Expiring (From Endpoint) ou Non-Expiring (From Endpoint) |
Expire Key |
Define uma chave no arquivo do tipo JSON de resposta do endpoint que contém a duração de um token, em segundos, como por exemplo "expires_in". Disponível apenas para a autenticação do tipo Bearer Token do tipo Expiring (From Endpoint) |
Use Fixed Expire |
Define um tempo fixo de expiração para um token fornecido manualmente, como por exemplo 3600 segundos. Selecionar esta opção desativa a opção Expire Key. Disponível apenas para a autenticação do tipo Bearer Token do tipo Expiring (From Endpoint) |
Duration |
Define o tempo de validade de um token, que deve ser um valor numérico. Disponível apenas quando a opção Use Fixed Expire está selecionada |
Scale |
Define a unidade de tempo utilizada para a opção Duration. As opções disponíveis são Second(s), Minute(s), Hour(s) ou Day(s). Disponível apenas quando a opção Use Fixed Expire está selecionada |
Bearer Token |
Define um token fixo que é utilizado na autenticação. Disponível apenas para a autenticação do tipo Bearer Token do tipo Non-Expiring (Provided) |
Aba Routes
As opções disponíveis na aba Routes estão descritas na tabela a seguir.
Opções disponíveis na aba Routes
Opção |
Descrição |
|---|---|
Endpoint |
Define os endpoints que são utilizados em requisições. Cada endpoint deve começar com uma barra seguida de um caminho, como por exemplo "/api/usuarios". Também é possível definir segmentos dinâmicos em um endpoint, que são substituídos por valores configurados via Tags em uma requisição. Estes segmentos devem ser indicados por dois pontos, como por exemplo "/api/empresa/:empresaId/usuario/:usuarioId" |
Route Alias |
Define um apelido para uma rota. Este apelido é utilizado posteriormente para vincular Tags de uma aplicação a uma rota específica. O valor desta opção diferencia entre maiúsculas e minúsculas |
Esta opção indica que uma rota específica utiliza o método de autenticação configurado na opção Auth Type da aba Auth |
|
Add Route |
Adiciona uma rota à tabela de rotas configuradas |
Clicar com o botão direito do mouse em uma rota mostra as opções Edit, que abre a janela Params Config, e Delete, que permite remover a rota selecionada. Clicar duas vezes em uma rota também abre a janela Params Config, mostrada na figura a seguir, que permite configurar os parâmetros específicos de uma rota.
Janela Params Config
As opções disponíveis na janela Params Config estão descritas na tabela a seguir.
Opções disponíveis na janela Params Config
Opção |
Descrição |
|---|---|
Param Key |
Define o nome de um parâmetro a ser utilizado em uma requisição |
Default Value |
Define um valor padrão para um parâmetro. Se nenhum valor é fornecido, considera-se esta opção como vazia |
Permite definir uma expressão regular (regular expression) para validar um valor atribuído a um parâmetro, se necessário |
|
Is Mandatory |
Selecionar esta opção impede o envio de uma requisição se um parâmetro não está configurado ou está configurado com um valor vazio |
Add Param |
Adiciona um novo parâmetro às tabelas Query Params ou Header Params. Cada uma destas tabelas possui a respectiva opção Add Param, que permite inserir um parâmetro de consulta (query) ou de cabeçalho (header), respectivamente |
Save and Close |
Salva os dados configurados e fecha esta janela |
Clicar com o botão direito do mouse em um parâmetro de qualquer uma das tabelas mostra a opção Delete, que permite remover o parâmetro selecionado.
Os parâmetros Content-Type e Authorization são inseridos automaticamente como parâmetros do tipo header na tabela Header Params. Estes parâmetros não podem ser excluídos nem configurados posteriormente por meio de Tags.
Em caso de se utilizar um tipo de autenticação diferente das opções disponíveis na aba Auth, como por exemplo usar uma chave de API, uma rota pode ser configurada para não usar autenticação, ou seja, desmarcar a opção Auth Required, e neste caso os parâmetros header podem ser configurados, definindo os respectivos valores da coluna Default Value tanto manualmente quanto em tempo de execução usando Tags.
Aba Templates
As opções disponíveis na aba Templates estão descritas na tabela a seguir.
Opções disponíveis na aba Templates
Opção |
Descrição |
Template Name |
Define o nome de um modelo, no formato JSON, que é utilizado para as requisições e respostas de uma API |
Add Template |
Adiciona um modelo à tabela de modelos configurados |
Clicar com o botão direito do mouse em um modelo mostra as opções Edit, que abre a janela Template Config, e Delete, que permite remover o modelo selecionado. Clicar duas vezes em um modelo também abre a janela Template Config, mostrada na figura a seguir, que permite configurar um modelo no formato JSON, conforme o padrão de sintaxe deste formato descrito no tópico a seguir.
Janela Template Config
A opção disponível na janela Template Config é Save and Close, que salva os dados configurados e fecha esta janela.