Integrações privadas: tudo o que você precisa saber

As integrações privadas permitem criar conexões seguras e personalizadas entre sua conta e qualquer aplicativo de terceiros. Esse recurso é ideal para ferramentas internas, fluxos de trabalho automatizados e sistemas personalizados que precisam de acesso à API sem a necessidade de criar um aplicativo público completo.

O que são integrações privadas?

As Integrações Privadas permitem que você crie integrações personalizadas poderosas entre sua conta e qualquer outro aplicativo de terceiros.

Se você deseja integrar sua conta com um aplicativo de terceiros, você tem duas opções:

• Encontre e instale o aplicativo relevante na Loja de Aplicativos.
• Crie sua própria integração privada, sozinho ou com a ajuda de um desenvolvedor, usando APIs.

As Integrações Privadas ajudam você a atingir o objetivo de criar sua própria integração com segurança.

As principais vantagens de usar integrações privadas são:

• Simples: gere tokens de integração privada nas configurações da sua conta e gerencie-os com facilidade.
• Segurança: você pode restringir os escopos/permissões que um desenvolvedor pode acessar em sua conta.

Qual a diferença entre integrações privadas e chaves de API?

Simplificando, integrações privadas são uma alternativa mais poderosa e segura às chaves de API.

Por que os tokens de integração privados são recomendados para novas credenciais?

Os Tokens de Integração Privada (PIT) são a alternativa recomendada às chaves de API legadas, pois oferecem um gerenciamento de acesso mais seguro e flexível.

Chaves de API legadas que permanecerem sem uso por mais de 90 dias podem ser marcadas como Expiradas nas configurações. Como a criação de novas chaves legadas v1 não é mais suportada, o PIT deve ser usado para quaisquer novas credenciais ou ao migrar integrações antigas para um modelo de acesso mais seguro.

Qual a diferença entre integrações privadas e tokens de acesso OAuth2?

Simplificando, integrações privadas são tokens de acesso OAuth2 estáticos/fixos.

Como faço para usar as integrações privadas?

Os tokens de integração privada são usados no cabeçalho de autorização, assim como outros tokens de acesso.

Por exemplo, para obter os detalhes de uma localização, você pode usar a API Obter Subconta com o Token de Integração Privado da Agência no cabeçalho de Autorização.

curl --request GET \
  --url https://services.leadconnectorhq.com/locations/ve9EPM428h8vShlRW1KT \
  --header 'Accept: application/json' \
  --header 'Authorization: <YOUR PRIVATE INTEGRATION TOKEN>' \
  --header 'Version: 2021-07-28'

Testando uma integração privada com chamadas de API

Após criar sua Integração Privada, você pode testá-la enviando dados para um endpoint da API. Para isso, você precisará da URL correta do endpoint da API.

Aqui está um exemplo de como testar a integração adicionando um novo contato:

curl --request POST \
  --url https://services.leadconnectorhq.com/contacts/ \
  --header 'Authorization: <YOUR PRIVATE INTEGRATION TOKEN>' \
  --header 'Content-Type: application/json' \
  --header 'Version: 2021-07-28' \
  --data '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "locationId": "LOCATION_ID"
  }'

Certifique-se de:

• Substituir LOCATION_ID pelo ID real da subconta.
• Substituir o valor de Autorização pelo seu token de Integração Privada gerado.

Como faço para gerenciar integrações privadas?

Quem pode criar integrações privadas?

Por padrão, todos os administradores da agência podem criar e gerenciar integrações privadas.

No entanto, você pode restringir essa permissão no nível do usuário. Para fazer isso, acesse Configurações > Equipe > Editar o administrador da agência específico > Funções e permissões e ative/desative as Integrações privadas para o administrador da agência.

Você pode aplicar as restrições em dois níveis:

• Permitir que o administrador da agência visualize e gerencie as integrações privadas da agência.
• Permitir que o administrador da agência visualize e gerencie as integrações privadas das subcontas.

Onde posso encontrar integrações privadas?

Você pode encontrar as Integrações Privadas nas configurações da agência. Caso não as encontre nas configurações, verifique se o recurso está ativado no Labs.

Como faço para criar uma nova integração privada?

Melhores práticas de segurança do token de integração privado

Recomendamos que você rotacione seus tokens de Integração Privada a cada 90 dias.

Você terá um período de 7 dias durante o qual tanto o token antigo quanto o novo continuarão funcionando. Após 7 dias, o token antigo expirará. Nesse período de 7 dias, você terá a opção de:

• "Cancelar rotação" se, por exemplo, o desenvolvedor precisar de mais tempo para atualizar o token no aplicativo de terceiros.
• "Expirar agora", por exemplo, se o aplicativo de terceiros tiver sido atualizado com o novo token.

Token comprometido?

Posso editar as permissões de integração privada sem atualizar o token?

Sim, você pode editar o nome, a descrição e os escopos/permissões da Integração Privada a qualquer momento após tê-la criado.

Como faço para excluir a integração privada?

Você pode excluir a Integração Privada assim que não precisar mais do aplicativo de terceiros. Para isso, acesse Integrações Privadas nas configurações e selecione "Excluir" no menu de três pontos.