Guia de Integrações Privadas na Marketek: Crie Conexões Seguras com a API

Para usuários avançados e desenvolvedores que buscam expandir as capacidades da Marketek, a funcionalidade de Integrações Privadas é a porta de entrada para criar conexões customizadas e seguras com outros aplicativos e sistemas.

Diferente das integrações nativas, este recurso oferece um controle granular sobre o acesso aos dados da sua conta, utilizando tokens de autorização específicos. Este guia completo explicará o que são as Integrações Privadas, por que elas são a alternativa mais moderna e segura às chaves de API tradicionais, e como você pode criá-las e gerenciá-las.

O que você aprenderá neste guia:

1. O Que São Integrações Privadas e Seus Benefícios?

Uma Integração Privada é uma forma segura de construir conexões customizadas entre sua conta Marketek e um aplicativo de terceiros, utilizando a API da plataforma. Se a integração que você precisa não está disponível no nosso Marketplace, este é o caminho para construí-la por conta própria ou com a ajuda de um desenvolvedor.

Principais Vantagens:

• Segurança Aprimorada: O maior benefício. Você pode restringir exatamente quais permissões (escopos) a integração terá na sua conta. Por exemplo, você pode permitir que um aplicativo leia contatos, mas não os exclua.

• Simplicidade: Gerar e gerenciar os tokens de acesso é um processo simples e direto, feito dentro das configurações da sua conta.

• Tecnologia Moderna: As Integrações Privadas utilizam a API v2.0, que é a versão mais recente, mais poderosa e com mais recursos da nossa API, incluindo suporte a webhooks (notificações de eventos em tempo real).

• Acesse API Marketek!

2. Integrações Privadas vs. Chaves de API: Qual a Diferença?

As Integrações Privadas são a evolução das tradicionais chaves de API. Veja a comparação:

Em resumo, sempre que precisar criar uma nova conexão via API, dê preferência às Integrações Privadas.

3. Passo a Passo: Criando e Gerenciando sua Integração Privada

a) Quem pode criar e onde encontrar?

• Permissões: Por padrão, todos os Administradores da conta podem criar e gerenciar Integrações Privadas. Essa permissão pode ser ajustada em Configurações > Minha Equipe.

• Onde Encontrar:

  1. Navegue até Configurações.

  2. No menu esquerdo, role para baixo até a seção "Outras Configurações" e clique em "Integrações Privadas" (Private Integrations).

  3. Não encontrou? Verifique em Configurações > Labs se o recurso precisa ser ativado para sua conta.

b) Criando uma Nova Integração Privada

1. Na tela de Integrações Privadas, clique em "Criar nova Integração".

2. Dê um Nome e Descrição: Insira um nome claro para identificar a integração (ex: "Conexão com Sistema de BI") e uma breve descrição do seu propósito.

3. Selecione os Escopos (Permissões): Esta é a etapa de segurança mais importante. Marque as caixas de seleção correspondentes às permissões que você deseja conceder. Seja restritivo: conceda apenas as permissões estritamente necessárias para a integração funcionar.

4. Copie o Token Gerado: Após salvar, a plataforma gerará um token (uma longa sequência de caracteres). Copie este token imediatamente e guarde-o em um local seguro. Por razões de segurança, você não poderá visualizá-lo novamente mais tarde.

c) Editando Permissões de uma Integração Existente

Você pode alterar o nome, a descrição e os escopos de uma integração a qualquer momento, sem precisar gerar um novo token.

1. Na lista de Integrações Privadas, clique no menu de três pontos (⋮) ao lado da integração e selecione "Editar".

2. Faça as alterações desejadas nas permissões e clique em "Atualizar".

d) Excluindo uma Integração Privada

Se uma integração não é mais necessária, você pode e deve excluí-la para remover o acesso.

1. Na lista, clique no menu de três pontos (⋮) e selecione "Excluir".

2. Confirme a exclusão. Atenção: Esta ação é permanente e revogará imediatamente o acesso do token associado.

4. Como Usar o Token de Integração Privada

O token que você copiou funciona como uma senha para a API. Seu desenvolvedor o utilizará no cabeçalho de autorização (Authorization Header) de cada requisição feita à API da Marketek, geralmente prefixado com "Bearer".

Exemplo técnico para o desenvolvedor:

Bash

curl --request GET \--url https://services.leadconnectorhq.com/contacts/{contactId} \--header 'Authorization: Bearer <SEU_TOKEN_DE_INTEGRACAO_PRIVADA>' \--header 'Version: 2021-07-28'

5. Melhores Práticas de Segurança

• Compartilhe com Cuidado: Trate seu token como uma senha. Compartilhe-o apenas com desenvolvedores ou aplicativos de confiança e nunca o exponha publicamente.

• Rotacione seus Tokens Regularmente: É uma boa prática de segurança rotacionar (gerar um novo e invalidar o antigo) seus tokens a cada 90 dias.

• O que fazer se um Token for Comprometido?

  1. Vá para as configurações da integração privada.

  2. Clique na opção "Rotacionar e expirar este token agora".

  3. A plataforma invalidará o token antigo imediatamente e gerará um novo.

  4. Copie o novo token e atualize-o no seu aplicativo de terceiro o mais rápido possível.

6. Conclusão e Próximos Passos

As Integrações Privadas são a forma mais segura e moderna de conectar a Marketek com seu ecossistema de ferramentas via API. Ao permitir o controle granular de permissões, elas oferecem a flexibilidade de que os desenvolvedores precisam com a segurança que seu negócio exige.

Sempre siga as melhores práticas, concedendo o mínimo de permissões necessárias e rotacionando seus tokens regularmente para manter sua conta protegida.

Se você tem dúvidas ou precisa de ajuda para configurar sua primeira Integração Privada, nossa equipe de suporte está à sua disposição.

Clique aqui para entrar em contato com o Suporte da Marketek