...
- No menu Inquilino , clique em Integrações.
A página Aplicativos conectados é exibida, como mostrado abaixo.
Um aplicativo conectado é uma integração que é configurada com a Luma no nível de inquilino. Depois que o aplicativo conectado for criado, a próxima etapa será criar a instância do aplicativo e as respectivas operações de serviço web. - Clique em Criar aplicativo para criar um novo aplicativo.
A página Criar aplicativo é exibida, como mostrado abaixo. - Digite o Nome do aplicativo.
- Selecione o Tipo de integração.
- Clique em Criar para concluir a criação do aplicativo.
O aplicativo criado é disponibilizado na lista Aplicativos conectados . A próxima etapa é criar uma instância.
...
- Na página Aplicativos conectados , clique em Criar instância , como mostrado abaixo.
A página Criar instância é exibida, como mostrado abaixo.
- Digite o Nome e a Descrição da instância. A próxima etapa é definir as credenciais e os detalhes de conexão dessa instância.
Insira o URL base ao qual a Luma deve se conectar.
O Tipo de autorização é usado pela Luma para efetuar logon e executar as operações especificadas como parte da operação do serviço web.
A Luma oferece suporte aos seguintes tipos de autorização:
- Nenhuma autenticação: use essa opção se não precisar de autenticação para efetuar logon em sistemas de terceiros.
- Autenticação básica: use essa opção para autenticar aplicativos externos para interação com o inquilino da Luma. A autenticação básica consiste nos seguintes campos:
- Nome de usuário: especifique o nome de usuário. A Luma o usa como um nome de usuário de autenticação para efetuar logon em sistemas de terceiros.
- Senha: especifique a senha. A Luma usa essa senha ao se autenticar para o sistema de terceiros.
- Nome do cabeçalho de autorização: por padrão, o Nome do cabeçalho de autorização é especificado como Autorização pela Luma.
- Token do portador: esse é o token de autenticação exclusivo necessário para aplicativos externos se comunicarem com a API da Luma.
O token do portador consiste nos seguintes campos:- Nome do cabeçalho de autorização: por padrão, o Nome do cabeçalho de autorização é especificado como Autorização pela Luma.
- Token: informe o token de autenticação exclusivo necessário para aplicativos externos se comunicarem com a API da Luma.
- Parâmetro de caminho: o parâmetro de caminho faz parte de um segmento de caminho que ocorre após seu nome. Os parâmetros de caminho oferecem uma oportunidade única de substituir dinamicamente os valores e passá-los no URL. Por exemplo, http://myserver.com/some-path/{parameter1}/path-continued/{parameter2}.
- Insira o Campo externo e o Valor.
- Parâmetro de consulta: os parâmetros de consulta, às vezes, são chamados de parâmetros opcionais. Os parâmetros de consulta são separados dos parâmetros hierárquicos pelo ponto de interrogação. Os parâmetros de consulta são exibidos no URL após o ponto de interrogação (
?) depois do nome do recurso. https://myserver.com/resource-name?param1=value1¶m2=value2.- Insira o Campo externo e o Valor.
- Cabeçalhos: cabeçalhos são, em sua maioria, classificados como cabeçalhos de solicitação. Será necessário definir os cabeçalhos de solicitação quando você estiver enviando a solicitação.
- Insira o Campo externo e o Valor.
Os cabeçalhos de amostra a seguir são os mais encontrados.- Autorização: inclui credenciais contendo as informações de autenticação do cliente para o recurso que está sendo solicitado.
Accept-Charset: esse é um cabeçalho que é definido com a solicitação e informa o servidor sobre quais conjuntos de caracteres são aceitáveis pelo cliente.
Content-Type: indica o tipo de mídia (texto/HTML ou texto/JSON, XML/personalizado) da resposta enviada ao cliente pelo servidor. Isso ajudará o cliente a processar o corpo da resposta corretamente.
- Insira o Campo externo e o Valor.
Click Create to create the app instance.
Info A primeira instância que você adicionar será considerada como a instância padrão.
...
- Na página Aplicativos conectados , clique em Criar operação , como mostrado abaixo.
A página Criar operação é exibida, como mostrado abaixo.
- Na guia Detalhes da operação , informe o Nome da operação.
- O sistema exibe automaticamente o Domínio da habilidade padrão do inquilino.
- O URI (Uniform Resource Identifier - Identificador de Recurso Uniforme) é usado para se referir ao recurso de informações. Insira o URI.
- Selecione o método da operação. Ele usa uma estrutura de encadeamento de solicitação de API para que os bots enviem ou solicitem dados dos sites, sistemas e aplicativos web usando serviços web.
Os seguintes métodos de operação estão disponíveis:- Get: para recuperar dados
- Post: para criar dados
- Put: para editar os dados
- Delete: para excluir os dados
- O sistema exibe automaticamente a operação suportada conforme invoca a API REST.
- Especifique o Tempo limite (em milissegundos), isto é, por quanto tempo esperar por uma resposta do serviço web ao invocar uma solicitação de saída. O valor padrão é 10000 milissegundos, 10 segundos, e o valor máximo permitido é de 3 minutos, 180000 milissegundos.
- Clique em Avançar para especificar os detalhes da Configuração da solicitação .
A página Configuração da solicitação é exibida, como mostrado abaixo.
- Parâmetros de caminho: o parâmetro de caminho faz parte de um segmento de caminho que ocorre após seu nome. Os parâmetros de caminho oferecem uma oportunidade única de substituir dinamicamente os valores e passá-los no URL. Por exemplo, http://myserver.com/some-path/{parameter1}/path-continued/{parameter2}. É possível substituir a configuração definida no nível de instância ou continuar usando a mesma e talvez seja necessário adicionar valores e variáveis específicos da operação.
- Insira o Campo externo e o Valor.
- Parâmetros de consulta: os parâmetros de consulta, às vezes, são chamados de parâmetros opcionais. Os parâmetros de consulta são separados dos parâmetros hierárquicos pelo ponto de interrogação. Os parâmetros de consulta são exibidos no URL após o ponto de interrogação (
?) depois do nome do recurso. https://myserver.com/resource-name?param1=value1¶m2=value2. É possível substituir a configuração definida no nível de instância ou continuar usando a mesma e talvez seja necessário adicionar valores e variáveis específicos da operação.- Insira o Campo externo e o Valor.
- Cabeçalhos: cabeçalhos são, em sua maioria, classificados como cabeçalhos de solicitação. Será necessário definir os cabeçalhos de solicitação quando você estiver enviando a solicitação. É possível substituir a configuração definida no nível de instância ou continuar usando a mesma e talvez seja necessário adicionar valores e variáveis específicos da operação.
- Insira o Campo externo e o Valor.
Os cabeçalhos de amostra a seguir são os mais encontrados.- Autorização: inclui credenciais contendo as informações de autenticação do cliente para o recurso que está sendo solicitado.
Accept-Charset: esse é um cabeçalho que é definido com a solicitação e informa o servidor sobre quais conjuntos de caracteres são aceitáveis pelo cliente.
Tipo de conteúdo: indica o tipo de mídia (texto/HTML, texto/JSON, XML/personalizado ou multipart/form-data) da resposta enviada ao cliente pelo servidor. Isso ajudará o cliente a processar o corpo da resposta corretamente.
Info Use multipart/form-data como Tipo de conteúdo para enviar um arquivo de anexo ao servidor do cliente.
- Insira o Campo externo e o Valor.
- Carga de saída: a carga de solicitação precisa ser transmitida para conclusão da solicitação. FormData é a codificação padrão que um formulário da web usa para transferir dados. A área da caixa de texto aceita pares de chave-valor simples e JSON complexo/aninhado.
To send an attachment as Outbound payload, use Attachment Mapping. Enter a External Field and select an attribute with datatype File as Value.
- Clique em Avançar para criar a Configuração de resposta.
...
É possível criar os atributos Local e Personalizado do usuário para armazenar os dados que são usados em uma operação. O atributo Local armazena os dados temporários no fluxo de trabalho de ação para transmissão a várias operações. Ele é usado como um espaço reservado nos modelos e regras de mensagem do usuário dentro do fluxo de trabalho da ação. O atributo personalizado do usuário armazena os dados extraídos da entrada do usuário, da operação de integração de terceiros , das respostas, etc.
Veja a seguir os detalhes necessários no mapeamento de entrada:
...
Essa seção é usada para definir o comportamento e a resposta do bot para o usuário quando a execução da operação resulta em um erro. Você pode criar várias regras de tratamento de erros a partir das operações de serviço web.
Selecione uma das opções a seguir de modo a definir uma regra para enviar a mensagem de erro. A mensagem de erro será enviada apenas se as condições especificadas forem validadas:
...