As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Integração de conexão da API REST
Com a integração do REST API Connection no Amazon Quick, você pode realizar ações com APIs REST e serviços web personalizados. Essa integração suporta somente a execução de ações.
O que é possível fazer
Com a integração do REST API Connection, você pode realizar ações com APIs REST e serviços web personalizados por meio do conector de ação.
- Conector de ação
-
Execute solicitações HTTP, recupere dados e interaja com APIs usando opções flexíveis de autenticação.
nota
A integração da conexão da API REST não oferece suporte ao acesso a dados ou à criação de base de conhecimento. Ele foi projetado especificamente para execução de tarefas e interações de API com serviços web personalizados.
Antes de começar
Antes de configurar a integração da API REST, verifique se você tem o seguinte:
-
Endpoint da API REST com permissões de acesso apropriadas.
-
Credenciais de autenticação de API (OAuth, chave de API ou outras).
-
Documentação da API para o serviço web de destino.
Prepare o endpoint e a autenticação da API
Antes de configurar a integração no Amazon Quick, prepare seu endpoint da API REST e suas credenciais de autenticação. A integração da conexão da API REST oferece suporte a vários métodos de autenticação. Escolha o método que corresponde aos seus requisitos de API:
- Autenticação do usuário (OAuth)
-
Reúna as seguintes informações do seu provedor de API:
URL base - URL base da API REST.
ID do cliente - ID do cliente do aplicativo OAuth.
Segredo do cliente - segredo do cliente do aplicativo OAuth.
URL do token - ponto final do token OAuth.
URL de autenticação - ponto final de autorização do OAuth.
URL de redirecionamento - URI de redirecionamento do OAuth.
- Autenticação de serviço (Service-to-service OAuth)
-
Reúna as seguintes informações do seu provedor de API:
Tipo de autenticação - as credenciais do cliente OAuth 2.0 concedem fluxo para autenticação de serviço a serviço.
URL base - URL base da API REST.
ID do cliente - identificador do cliente do aplicativo OAuth para autenticação de serviços.
Segredo do cliente - segredo do cliente do aplicativo OAuth para autenticação do serviço.
URL do token - ponto final do token OAuth para obter tokens de acesso.
Cabeçalhos e parâmetros personalizados
Você pode usar cabeçalhos e parâmetros personalizados para autenticação flexível e interação com a API:
Cabeçalhos de autenticação personalizados.
Cabeçalhos da versão da API.
Content-Type especificações.
Parâmetros de consulta personalizados.
Configurar a integração da API REST
Depois de preparar seu endpoint de API e suas credenciais de autenticação, siga estas etapas para criar sua integração com a API REST:
-
No console do Amazon Quick, escolha Conectores.
-
Escolha a guia Criar para sua equipe.
-
Encontre e escolha Conexão da API REST.
-
Preencha os detalhes da integração:
-
Nome - Nome descritivo para sua integração com a API REST.
-
Descrição (opcional) - Objetivo da integração.
-
-
Escolha seu tipo de conexão:
-
Autenticação do usuário - OAuth-based autenticação para acesso individual do usuário.
-
Autenticação de serviço - Autenticação baseada em chave de API para acesso ao serviço.
-
-
Preencha as configurações de conexão com base no método de autenticação selecionado (usuário ou serviço).
-
Escolha Próximo.
-
Analise as ações que estão disponíveis.
-
Selecione Criar e continuar.
Ações de tarefas disponíveis
Depois de criar sua integração com a API REST, você pode revisar as ações disponíveis para interagir com a API REST. As ações comuns da API REST incluem:
Solicitações HTTP GET para recuperação de dados.
Solicitações HTTP POST para criação de dados.
PUT/PATCH Solicitações HTTP para atualizações de dados.
Solicitações HTTP DELETE para remoção de dados.
Interações personalizadas de endpoint.
Processamento de dados JSON e XML.
Parâmetros de consulta e gerenciamento de cabeçalhos.
nota
As ações específicas disponíveis dependem dos endpoints da API REST e das permissões de autenticação configuradas para sua integração.
Opções de configuração da API
Você pode configurar vários aspectos da integração da API REST para atender aos seus requisitos específicos.
Configuração do endpoint
Defina essas configurações de endpoint:
URL base e caminhos de endpoint.
Especificações do método HTTP.
Tratamento do formato de solicitação e resposta.
Tratamento de erros e lógica de repetição.
Tratamento de dados
Configure como sua integração processa diferentes formatos de dados:
Processamento de solicitações e respostas JSON.
Transformação de dados XML.
Dados de formulários e carregamentos em várias partes.
Manipulação de dados binários.
Gerencie integrações da API REST
Depois de criar sua integração com a API REST, você pode gerenciá-la usando estas opções:
-
Editar integração - Atualize as configurações de autenticação, o URL base ou a configuração da API.
-
Compartilhe a integração - Disponibilize a integração para outros usuários em sua organização.
-
Monitore o uso - Visualize a atividade de integração e as métricas de chamadas da API.
-
Revise as ações - Veja a lista completa das ações da API REST disponíveis.
-
Teste os endpoints - valide a conectividade e a autenticação da API.
-
Excluir integração - remova a integração e revogue a autenticação associada.
Importante
As integrações da API REST dependem da disponibilidade e da configuração do serviço web de destino. Alterações na API ou nos requisitos de autenticação podem afetar a funcionalidade de integração.
