Loading
Configurar e manter a sua organizaĆ§Ć£o do Salesforce
ƍndice
Filtrar por (0)Adicionar
Selecionar filtros

          Sem resultados
          Sem resultados
          Aqui estĆ£o algumas dicas de pesquisa

          Verifique a grafia das palavras-chave.
          Tente utilizar termos mais genƩricos.
          Selecione menos filtros para ampliar sua pesquisa.

            Pesquisar em toda a Ajuda do Salesforce
            Pesquisar em toda a Ajuda do Salesforce
            Usar chaves de API em cabeƧalhos personalizados com credenciais nomeadas

            VocĆŖ estĆ” aqui:

            1. Ajuda do Salesforce
            2. DocumentaĆ§Ć£o
            3. Configurar e manter a sua organizaĆ§Ć£o do Salesforce

            Usar chaves de API em cabeƧalhos personalizados com credenciais nomeadas

            Os serviƧos da Web geralmente definem seus prĆ³prios protocolos de autenticaĆ§Ć£o usando cabeƧalhos personalizados. Nesses casos, Ć© possĆ­vel criar um cabeƧalho personalizado para uma credencial nomeada ou externa e usar chaves de API como uma senha.

            EdiƧƵes obrigatĆ³rias

            DisponĆ­vel em: Salesforce Classic (nĆ£o disponĆ­vel em todas as organizaƧƵes) e Lightning Experience
            Disponƭvel em: todas as ediƧƵes

            O esquema de credenciais nomeadas inclui suporte para protocolos de autenticaĆ§Ć£o, como OAuth 2.0 e AWS Signature v4. Alguns provedores de serviƧos da Web tĆŖm seus prĆ³prios protocolos de autenticaĆ§Ć£o que usam cabeƧalhos exclusivos para autenticaĆ§Ć£o. Nesses casos, escolha um protocolo de autenticaĆ§Ć£o Custom para suas credenciais externas e use um cabeƧalho personalizado para se autenticar para esses sistemas.

            Uma abordagem comum usada pelos provedores de serviƧos da Web para autenticaĆ§Ć£o personalizada Ć© Chaves de API. AlĆ©m de autenticaĆ§Ć£o, as chaves de API tambĆ©m podem ser usadas para vĆ”rios serviƧos relacionados a HTTP, como cache ou cookies. Para credenciais nomeadas, Ć© possĆ­vel criar um cabeƧalho personalizado que use chaves de API como um protocolo de autenticaĆ§Ć£o com o valor de segredo da chave funcionando como uma senha.

            Cada serviƧo da Web pode atribuir um nome a seus cabeƧalhos de forma arbitraria. Nomes comuns incluem ACCESS_TOKEN, bearer, Client-ID, developer-token e X-API-Key.

            Para o padrĆ£o HTTP 1.x, uma chamada que usa uma chave de API (armazenada) pode se parecer da seguinte forma.

            GET https://example.com HTTP/1.1
Client-ID: abc123

            Aqui, a chave de API Client-ID tambĆ©m Ć© o nome do cabeƧalho e abc123 Ć© o valor da chave de API usada para autenticaĆ§Ć£o. O nome e o valor sĆ£o definidos pelo sistema de autenticaĆ§Ć£o. Geralmente vocĆŖ recupera esses parĆ¢metros por meio da interface de usuĆ”rio do sistema externo.

            O padrĆ£o HTTP inclui um cabeƧalho Authorization para autenticaĆ§Ć£o. Por padrĆ£o, as credenciais nomeadas do Salesforce usam esse cabeƧalho de autorizaĆ§Ć£o padrĆ£o. No entanto, vocĆŖ pode substituir o padrĆ£o e criar um cabeƧalho de AutorizaĆ§Ć£o personalizado. Este exemplo mostra o cabeƧalho de Authorization usado com uma chave de API. 

            GET https://example.com HTTP/1.1 
Authorization: Client-ID abc123

            As etapas gerais para usar chaves de API com credenciais nomeadas sĆ£o:

            1. Crie uma credencial externa, definindo o Protocolo de autenticaĆ§Ć£o como Personalizado. Uma credencial externa armazena informaƧƵes de autenticaĆ§Ć£o e autorizaĆ§Ć£o e Ć© usada por credenciais nomeadas.
            2. Armazene a chave de API como um parĆ¢metro de autorizaĆ§Ć£o em uma entidade de seguranƧa.
            3. Crie um cabeƧalho personalizado para a credencial externa. O cabeƧalho faz referĆŖncia Ć  chave de API.
            4. Crie uma credencial nomeada que faƧa referĆŖncia Ć  credencial externa.

            Armazenar uma chave de API como um parĆ¢metro de autenticaĆ§Ć£o em uma entidade de seguranƧa

            Recomendamos fortemente armazenar os parĆ¢metros de autenticaĆ§Ć£o da chave de API como parte de uma entidade de seguranƧa de credencial externa.

            A chave de API Ć© um valor secreto. Os parĆ¢metros de autenticaĆ§Ć£o devem conter segredos e sĆ£o armazenados de maneira criptografada consistente com outras informaƧƵes confidenciais. AlĆ©m disso, o acesso aos segredos Ć© concedido de maneira explĆ­cita usando uma entidade de seguranƧa.

            Uma entidade de seguranƧa vincula uma credencial externa a conjuntos de permissƵes e perfis. Ao adicionar parĆ¢metros de autenticaĆ§Ć£o a uma entidade de seguranƧa, vocĆŖ permite que diferentes grupos de usuĆ”rios do Salesforce usem diferentes tokens de autenticaĆ§Ć£o para chamar o mesmo serviƧo externo.

            1. Crie uma credencial externa e defina o campo Protocolo de autenticaĆ§Ć£o como Personalizado. Para obter instruƧƵes sobre a criaĆ§Ć£o e a configuraĆ§Ć£o de credenciais externas, consulte Criar ou editar uma credencial externa de autenticaĆ§Ć£o personalizada. Neste exemplo, a credencial externa se chama MyCustAuthExternCred.

              Nova credencial externa com autenticaĆ§Ć£o personalizada

            2. Na pƔgina da credencial externa, role para Entidades de seguranƧa.
            3. Para criar uma entidade de seguranƧa, clique em Novo e defina estes campos.

              Mapeamento de entidade de seguranƧa para autenticaĆ§Ć£o personalizada

              Nome do parĆ¢metro
              Um nome para a entidade de seguranƧa, como Administrador ou Equipe de marketing.
              NĆŗmero de sequĆŖncia
              Esse nĆŗmero determina qual mapeamento Ć© usado para a chamada, classificado do mais baixo para o mais alto. Defina o nĆŗmero de sequĆŖncia caso um usuĆ”rio tenha vĆ”rios conjuntos de permissƵes usados em vĆ”rias entidades de seguranƧa.
              Tipo de identidade
              A autenticaĆ§Ć£o personalizada usa o tipo de identidade Entidade de seguranƧa nomeada. Entidade de seguranƧa nomeada indica que os usuĆ”rios do Salesforce compartilham uma chave de API e que eles nĆ£o tĆŖm acesso exclusivo ao serviƧo externo. NĆ£o Ć© possĆ­vel alterar o tipo de identidade para autenticaĆ§Ć£o personalizada.
              Nota
              Nota No momento, apenas o protocolo OAuth oferece suporte a acesso exclusivo por usuĆ”rio a um sistema remoto. Nesse caso, cada usuĆ”rio faz login separadamente antes que a integraĆ§Ć£o funcione no contexto do usuĆ”rio.
              Nome
              O nome do parĆ¢metro de autenticaĆ§Ć£o. Neste exemplo, o nome Ć© MyClientId.
              Valor
              O valor da chave de API. Em muitos casos, vocĆŖ obtĆ©m a chave de API da interface do usuĆ”rio da comunidade.
            4. Mapeie a entidade de seguranƧa para um conjunto de permissƵes ou perfil. Consulte Habilitar entidades de seguranƧa de credencial externa. VocĆŖ pode mapear uma entidade de seguranƧa para vĆ”rios conjuntos de permissƵes, grupos de conjuntos de permissƵes ou perfis.

            Usar chaves de API em um cabeƧalho personalizado

            Depois de adicionar chaves de API a uma entidade de seguranƧa, vocĆŖ pode usar essas chaves em um cabeƧalho personalizado.

            1. Na credencial externa criada, role para CabeƧalhos personalizados e clique em Novo.
            2. Preencha os campos do cabeƧalho personalizado.

              Crie um cabeƧalho personalizado com fĆ³rmulas

              Nome
              O nome do cabeƧalho de solicitaĆ§Ć£o HTTP padrĆ£o conforme exigido pelo serviƧo externo. Neste caso, estamos realizando a autenticaĆ§Ć£o, portanto, usamos o nome padrĆ£o HTTP "AutorizaĆ§Ć£o".
              Valor
              O nome e o valor da chave de API. Pode ser uma expressĆ£o literal ou programĆ”tica.
              O valor pode ser expresso programaticamente com campos de mesclagem e fĆ³rmulas. Por exemplo, o valor pode assumir esta forma.
              {!'Client-ID ' & $Credential.Container.ParameterName}
              Neste exemplo, a string literal Client-ID Ć© concatenada com a chave de API e a expressĆ£o Ć© resolvida como:
              {!'Client-ID ' & $Credential.MyCustAuthExternCred.MyClientId}
              As fĆ³rmulas podem ser usadas em valores de cabeƧalho por meio da sintaxe {!FormulaGoesHere}. Qualquer coisa dentro de {!} Ć© avaliada como uma fĆ³rmula do Salesforce. As fĆ³rmulas oferecem poder e flexibilidade significativos para criar valores de cabeƧalho sem codificaĆ§Ć£o.
              Os campos de mesclagem fornecem acesso a valores criptografados por meio da sintaxe $Credential.Container.ParameterName. Neste exemplo, Container Ć© a credencial externa MyCustAuthExternCred. ParameterName Ć© o parĆ¢metro de autenticaĆ§Ć£o principal MyClientId mapeado para o valor da chave de API.
              NĆŗmero de sequĆŖncia
              Esse nĆŗmero determina qual cabeƧalho "ganha" e Ć© usado para a chamada, classificado do menor para o maior. Se nĆ£o estiver preocupado com conflitos com outros cabeƧalhos, deixe esse campo como o padrĆ£o.
              A credencial externa agora mostra o cabeƧalho personalizado com uma referĆŖncia ao parĆ¢metro de autorizaĆ§Ć£o que contĆ©m a chave de API.

              Credencial externa com autenticaĆ§Ć£o personalizada

            Se Client-ID for abc123, a chamada resultante terĆ” a aparĆŖncia seguinte. A credencial nomeada Ć© anexada AutorizaĆ§Ć£o: como o nome do cabeƧalho. 

            GET https://example.com HTTP/1.1 
Authorization: Client-ID abc123
            Dica
            Dica Lembre-se de habilitar as credenciais externas de usuĆ”rio para os usuĆ”rios que estĆ£o usando as credenciais nomeadas. Consulte Habilitar credenciais externas do usuĆ”rio.

            Usar chaves de API com uma credencial nomeada

            Depois de criar uma credencial externa que usa chaves de API, ela pode ser referenciada por uma credencial nomeada.

            1. Desabilite Gerar cabeƧalho de autorizaĆ§Ć£o na credencial nomeada. Desabilitar essa opĆ§Ć£o garante que a credencial nomeada use o cabeƧalho de Authorization personalizado que vocĆŖ criou.
            2. Nessa credencial nomeada, verifique se a opĆ§Ć£o Permitir fĆ³rmulas no cabeƧalho HTTP estĆ” habilitada.

            A callout using this named credential returns successfully because it has the correct Authorization header. If the tokens expire or the URL changes, no changes to Apex code are needed. In addition to Apex, the credential can be used in no-code tools such as External Services that provide integration with Flow.

            Consulte tambƩm:

             
            Carregando
            Salesforce Help | Article