Criar e gerenciar conexões para suas APIs
Crie conexões para autorizar o uso de ações ativadas para APIs do MuleSoft e chamadas HTTP no Salesforce. Você cria conexões para outras origens de API externas de fora do Catálogo de API e então pode visualizar as conexões do catálogo.
Edições obrigatórias
| Disponível em: Lightning Experience |
| Disponível em: Edições Developer, Enterprise, Performance e Unlimited |
Crie conexões antes de ativar uma ação para suas APIs. Se uma API do MuleSoft ainda não tiver uma conexão, ao ativar ações para a API, você será conduzido pelo processo de criação de conexão.
- No Salesforce, em Configuração, na caixa Busca rápida, insira Catálogo de API e selecione Catálogo de API.
- Selecione a API do MuleSoft para a qual você deseja ativar ações.
- Para criar a conexão e ativar ações, clique em Ativar ações.
- Selecione a versão da API.
- Para personalizar o rótulo e o nome da conexão padrão, substitua o tipo.
- Insira uma descrição.
- Selecione um URL de destino (instância da API) para usar como a credencial nomeada gerenciada para essa conexão com o Salesforce. Se você não puder acessar um destino selecionado, peça para o administrador da Anypoint Platform aprovar o acesso e verificar o status novamente. Selecione um nível de SLA, se necessário. Consulte A documentação do MuleSoft: Solicitações do cliente, contratos e credenciais.
-
Clique em Criar e continuar.
Para APIs que usam a imposição de ID do cliente por meio do MuleSoft, a configuração de conexão é criada automaticamente, incluindo credenciais externas, credenciais nomeadas, serviços externos e conjuntos de permissões.
Para APIs que usam protocolos de autenticação externos ou personalizados, o Catálogo de API cria a credencial nomeada e define o Status de autenticação da conexão como Personalizado. Depois de concluir a conexão, verifique suas credenciais de conexão e termine de configurá-las conforme necessário. Consulte Criar ou editar uma credencial externa.
A primeira conexão que você cria é definida automaticamente como a conexão padrão. Para usar uma conexão diferente em suas automações, defina-a como a conexão padrão.
Você não pode voltar para atualizar a conexão imediatamente, mas pode concluir o processo de ativação da ação. Depois de criar a conexão, você poderá atualizar apenas o rótulo e a descrição da conexão. Para usar um URL de destino diferente, crie outra conexão para a versão da API usando o novo URL de destino.
Atribua permissões de usuário às conexões que você cria para evitar erros de permissão ao executar as ações da API.
Continue ativando ações para a API. Consulte Ativar ações invocáveis para APIs.
Criar várias conexões para uma API do MuleSoft
Se uma API do MuleSoft tiver vários URLs de destino (instâncias da API), você poderá criar várias conexões para a API. No entanto, você pode ter apenas uma conexão ativa por vez para cada URL de destino.
- No Salesforce, em Configuração, na caixa Busca rápida, insira Catálogo da API e selecione Catálogo da API.
- Selecione a API para a qual deseja criar uma conexão.
- Clique em Nova conexão.
- Selecione a versão da API.
- Para personalizar o rótulo e o nome da conexão padrão, que usam como padrão o nome e a versão da API, substitua o rótulo e o nome.
- Insira uma descrição.
- Selecione um URL de destino (instância da API) para usar como a credencial nomeada gerenciada para essa conexão com o Salesforce. Se você não puder acessar um URL de destino selecionado, peça para o administrador da Anypoint Platform aprovar o acesso e verificar o status novamente. Selecione um nível de SLA, se necessário. Consulte A documentação do MuleSoft: Solicitações do cliente, contratos e credenciais.
-
Clique em Concluído.
Para APIs que usam a imposição de ID do cliente do MuleSoft, a configuração de conexão é criada automaticamente, incluindo credenciais externas, credenciais nomeadas, serviços externos e conjuntos de permissões.
Para APIs que usam protocolos de autenticação externos ou personalizados, o Catálogo de API cria a credencial nomeada e define o Status de autenticação da conexão como Personalizado. Depois de concluir a conexão, verifique suas credenciais de conexão e termine de configurá-las conforme necessário. Consulte Criar ou editar uma credencial externa.
A primeira conexão que você cria é definida automaticamente como padrão. Para usar uma conexão diferente em suas automações, defina-a como a conexão padrão.
Definir conexões padrão para APIs do MuleSoft
Defina uma conexão como a conexão padrão usada por automações que executam as ações da API do MuleSoft associada. A primeira conexão criada é definida automaticamente como padrão.
- Selecione a guia Conexões para uma versão da API do MuleSoft.
- Para uma conexão que você deseja definir como padrão, selecione a ação Definir como padrão .
Criar uma conexão para uma chamada HTTP
Para criar uma conexão para dar suporte a uma chamada HTTP, crie uma conexão sem passar pelo processo de ação de ativação.
- No Salesforce, em Configuração, na caixa Busca rápida, insira Catálogo da API e selecione Catálogo da API.
- Selecione a API para a qual deseja criar uma conexão.
- Clique em Nova conexão.
- Selecione a versão da API.
- Para personalizar o rótulo e o nome da conexão padrão, que usam como padrão o nome e a versão da API, substitua o rótulo e o nome.
- Insira uma descrição.
- Selecione um URL de destino a ser usado como a credencial nomeada gerenciada para essa conexão com o Salesforce. O Catálogo de API lista apenas URLs de destino ativos, que são gerenciados no Gerenciador de API do Anypoint.
-
Clique em Concluído.
A configuração de conexão é criada automaticamente, incluindo credenciais externas, credenciais nomeadas, serviços externos e conjuntos de permissões.
Atribuir permissões de usuário para as conexões
Depois de criar a conexão, conceda aos usuários específicos do Salesforce acesso às ações ativadas para que possam usá-las em suas automações do Salesforce. Você é solicitado a atribuir permissões para conexões de API como parte do processo de criação de conexões. Se você ignorar essa etapa, poderá atribuir as permissões mais tarde. Para evitar erros de permissão, atribua permissões antes de tentar usar as ações de API associadas.
- No Salesforce, em Configuração, na caixa Busca rápida, insira Catálogo da API e selecione Catálogo da API.
- Selecione a API para a qual definir permissões de conexão.
-
Se Status da permissão for Não atribuído para essa API ou se você quiser atualizar a atribuição de permissão, clique em Atribuir.
A página Conjunto de permissões da API é aberta.
- Gerencie e adicione atribuições para usuários de acordo com os padrões da sua organização. Consulte detalhes em Gerenciar atribuições de conjuntos de permissões.
Editar conexões
Você pode atualizar o rótulo ou a descrição das conexões.
- No Salesforce, em Configuração, na caixa Busca rápida, insira Catálogo da API e selecione Catálogo da API.
- Selecione a versão da API a ser modificada.
- Na guia Conexões, clique em Editar.
- Atualize o rótulo ou a descrição da conexão.
Para usar um URL de destino diferente, crie outra conexão para a versão da API usando o novo URL de destino.
Excluir conexões
Exclua conexões não usadas e não padrão.
- No Salesforce, em Configuração, na caixa Busca rápida, insira Catálogo da API e selecione Catálogo da API.
- Selecione a API que tem a conexão a excluir.
-
Na guia Conexões , selecione uma conexão que não esteja definida como padrão e clique em Excluir.
Para excluir uma conexão definida como padrão, defina uma conexão diferente como padrão e, em seguida, exclua a conexão não padrão. Consulte Criar e gerenciar conexões para suas APIs.
