Integração de API para Empresas

Uma parte importante da integração do Plano Business ou do Plano Launch consiste em criar novas contas de perfil na Ayrshare para seus usuários ou clientes e permitir que seus usuários vinculem suas redes sociais na página de vinculação social. Cada um de seus usuários é configurado como um perfil de usuário Ayrshare. Um perfil de usuário obtém uma conexão para cada rede social.

Esta é a forma padrão de fazer o onboarding de clientes. Seus usuários conectam suas próprias contas sociais por meio da página de conexão via URL JWT com marca personalizada descrita abaixo — eles nunca fazem login na Ayrshare e nunca acessam seu dashboard. O dashboard é reservado à sua equipe interna (criação e gerenciamento de perfis, testes e publicação em nome de um cliente).

Fluxo de Trabalho de Integração

Para integrar a Ayrshare à sua aplicação, você precisará fazer duas chamadas de API:

Chame o endpoint Create Profiles para criar um novo perfil Ayrshare para o seu usuário.
Chame o endpoint Generate JWT para obter uma URL JWT.

A URL JWT permite que o seu usuário acesse com segurança a página de vinculação social por meio de autenticação single sign-on. Você exibirá essa página em uma nova aba, janela ou view controller para permitir que os usuários conectem suas contas de redes sociais.

Depois que seu usuário vincular suas contas de redes sociais, você poderá publicar posts, obter análises e gerenciar suas contas via API.

Por motivos de segurança, as plataformas de redes sociais exigem que os usuários se autentiquem pelo navegador, o que não pode ser feito por chamadas do servidor backend. Isso garante que seus usuários possam conectar com segurança suas contas de redes sociais fazendo login diretamente na página oficial de login de cada plataforma. As redes sociais restringem a autenticação apenas a domínios de parceiros autorizados, como a Ayrshare. Elas também bloqueiam iFrames, o que significa que você não pode incorporar ou exibir a página de vinculação da Ayrshare em um iFrame no seu site.

Criar um Perfil de Usuário Ayrshare

Criar um Perfil com a API

Quando um novo usuário se registra no seu sistema ou quando seu cliente clica no link de rede social no seu app, crie uma nova conta de perfil Ayrshare chamando o endpoint RESTful /profiles/create-profile ou usando os pacotes NPM ou PyPi.

Perfis

O retorno dessa chamada será a PROFILE KEY do seu usuário. Essa chave será usada para publicar em nome do seu usuário e gerenciar sua conta. Você deve armazená-la em um local seguro.

Criar um Perfil com o Dashboard (Equipe Interna)

Sua equipe interna também pode criar Perfis de Usuário diretamente no Developer Dashboard — útil para testes, onboarding manual de um perfil ou administração pontual. Esta é uma ferramenta da equipe, não um fluxo voltado ao cliente: seus clientes nunca recebem acesso ao dashboard e são sempre integrados por meio da página de conexão via URL JWT. Para onboarding em produção, crie perfis programaticamente com a API para que cada novo usuário seja provisionado automaticamente.

Gerenciar Perfis de Usuário no Dashboard

Pacote de Integração

Durante o seu onboarding como cliente do Plano Business ou Launch, você recebeu um pacote de integração personalizado com informações importantes de configuração e domínio, exemplos de chamadas de endpoint e muito mais. Consulte o titular principal da sua conta para obter essas informações. Você também pode recuperar ou redefinir o pacote de integração no dashboard, na página API. Certifique-se de primeiro alternar para o seu Perfil Primário.

Single Sign-On com Autenticação JWT

A Ayrshare usa um JWT (JSON Web Token) para autenticar seu usuário e realizar Single Sign-On à página de vinculação social. Um JWT é um mecanismo seguro para transmitir informações assinadas digitalmente e permite que a Ayrshare autentique você e seu usuário.

Gerar um JWT

Seu aplicativo construirá um JWT composto pela sua API Key, Profile Key do usuário e alguns outros parâmetros. Ele será assinado com sua chave privada de 1024 bits.

O token JWT é válido por 5 minutos. Consulte o Max Pack para um tempo de expiração maior.

Use o endpoint Generate JWT para que a Ayrshare crie o token e a URL de vinculação social. Abra a URL de vinculação social em uma nova aba ou janela, permitindo que seus usuários vinculem facilmente suas redes sociais.

A URL JWT é o caminho de onboarding recomendado para todos os clientes. Seus usuários se autenticam diretamente em cada rede social por conta própria — você nunca coleta ou armazena suas credenciais sociais. Se sua equipe precisar vincular uma conta manualmente durante testes, pode fazer isso pelo dashboard, mas trata-se de uma conveniência interna e não é assim que os clientes devem ser integrados.

White-Label da Página de Conexão de Contas

Como a página de conexão aberta pela URL JWT é a única interface Ayrshare que seus usuários verão, você deve personalizá-la com sua marca. Adicione seu logotipo e cabeçalhos personalizados, escolha quais redes sociais aparecem, defina o idioma da página e use seus próprios links de ajuda — e, com o Max Pack, aplique um arquivo CSS totalmente personalizado, favicon, título de página e rodapé. Essas opções são configuradas uma única vez pela sua equipe a partir do Perfil Primário e se aplicam a todas as URLs JWT que você gerar.

White-Label da Página de Conexão de Contas

Veja todas as opções de branding e personalização da página de conexão.

Logout Automático de uma Sessão de Perfil

Como Fazer Logout Automático da Sessão do Perfil AtivoSe um perfil já estiver logado, enviar o JWT de um perfil diferente não trocará de perfis. Isso é feito para tornar a experiência mais rápida para usuários já logados. Ao testar, faça logout do perfil atual antes de fazer uma chamada SSO com um perfil diferente. Perfis logados permanecem logados até fazerem logout explicitamente.No entanto, se você tiver uma necessidade de negócio, como seus usuários terem vários perfis que acessam com frequência, ou se você quiser testar, inclua o parâmetro de URL na URL do SSO:logout=truePor exemplo:https://profile.ayrshare.com?domain=[domain id]&jwt=[jwt token]&logout=trueIsso força um logout e depois faz login no novo perfil.Consulte também o endpoint Generate JWT para adicionar o logout automaticamente.Aviso: Usar o logout automático causa um atraso de desempenho para o seu usuário, portanto, a menos que você precise, sugerimos não forçar o logout e não usá-lo em produção.

A página de Contas Sociais tem um botão “Fechar” que fecha a janela e retorna o usuário ao seu site. Ao abrir a URL de vinculação social, recomendamos usar a função window.open() do JavaScript em vez de um href de âncora. O botão “Fechar” usa JavaScript para fechar a janela, e a maioria dos navegadores só permite que janelas abertas por script sejam fechadas. Você pode usar o código de exemplo a seguir no seu site para iniciar a janela de vinculação social.

Window Open

<div onclick="window.open('https://profile.ayrshare.com?domain...', '_blank')">
  Link Social Networks
</div>

Window Open Function

<button onclick="openNewTabAndRedirect()">Open New Tab and Redirect</button>
<script>
  function openNewTabAndRedirect() {
    // Open a new tab
    var newTab = window.open("https://profile.ayrshare.com?domain...");

    // Optional: Focus on the new tab
    newTab.focus();
  }
</script>

Você pode controlar o botão “Fechar” para redirecionar a aba de vinculação social para uma página de sua escolha ou redirecionar a aba/janela original e fechar a aba de vinculação social. Isso pode ser feito usando o parâmetro redirect e adicionando origin=true aos parâmetros de query da URL de redirecionamento. Consulte o endpoint Generate JWT para mais detalhes.

Redirecionando ao Fechar

Além disso, se você quiser que o botão Fechar redirecione de volta para sua página (geralmente útil em dispositivos móveis), passe o parâmetro GET redirect como uma string URL encoded iniciando com https. Consulte os parâmetros do endpoint Generate JWT para mais detalhes.

JWT URL

https://profile.ayrshare.com?domain=[domain id]&jwt=[jwt token]&redirect=https%3A%2F%2Fmywebsite.com

O redirecionamento será salvo para aquele perfil e usado em chamadas SSO subsequentes mesmo que o parâmetro redirect não seja passado. Para redefinir o botão Fechar de volta para fechar, passe o parâmetro redirect=null.

Mais Informações

Notificações de Vinculação ou Desvinculação de Usuário

Quando um usuário vincula ou desvincula uma rede social, você pode receber uma notificação via webhook. Consulte a página Social Action Webhooks para mais informações. Você também pode usar o endpoint user para obter as redes sociais conectadas a um perfil de usuário.

Múltiplos Conjuntos de Contas Sociais

Visão Geral

Cada Perfil de Usuário tem um conjunto de contas de redes sociais e pode criar uma conexão para cada rede social. Se seus usuários ou clientes tiverem múltiplos conjuntos de contas de redes sociais, como duas Páginas do Facebook, duas contas do Instagram e dois canais do YouTube, você pode gerenciar esses múltiplos conjuntos de contas seguindo estas etapas:

Crie múltiplos Perfis de Usuário - Crie Perfis de Usuário separados no sistema Ayrshare para cada conjunto de contas sociais que seu usuário ou cliente precise gerenciar.
Armazene Profile Keys únicas - Cada Perfil de Usuário terá sua própria Profile Key única, retornada pelo endpoint de criação de Perfil de Usuário.
Rotule seus perfis - Use title ou tag em cada Perfil de Usuário para identificar claramente quais contas de redes sociais eles estão associados (por exemplo, “Página do Facebook A” e “Página do Facebook B”).
Mapeie no seu banco de dados - No seu próprio sistema, associe todas as Profile Keys relevantes ao respectivo usuário ou cliente.
Use a Profile Key apropriada - Ao publicar conteúdo ou recuperar análises para uma conta social específica, use a Profile Key associada a essa conta. Por exemplo, para publicar na Página do Facebook A, use a Profile Key do Perfil de Usuário conectado à Página do Facebook A.

Exemplo

Vamos considerar um cenário prático para múltiplas contas de clientes:

Cliente: Rede de Restaurantes do Joe com duas unidades

Joe precisa de contas de redes sociais separadas para cada unidade do restaurante: Unidade 1:

Página do Facebook: “Joe’s Downtown Bistro”
Instagram: @joesdowntownbistro
LinkedIn: Página empresarial do Joe’s Downtown Bistro

Unidade 2:

Página do Facebook: “Joe’s Seaside Grill”
Instagram: @joesseasidegrill
LinkedIn: Página empresarial do Joe’s Seaside Grill

Solução de implementação:

Crie dois Perfis de Usuário separados na Ayrshare:

Perfil de Usuário 1: Intitulado “Contas do Joe’s Downtown Bistro”
Perfil de Usuário 2: Intitulado “Contas do Joe’s Seaside Grill”

Conecte as contas sociais apropriadas a cada perfil:

Perfil 1: Vincula Facebook, Instagram e LinkedIn do Downtown Bistro
Perfil 2: Vincula Facebook, Instagram e LinkedIn do Seaside Grill

Armazene ambas as Profile Keys no seu banco de dados, associando-as à conta do Joe:

Cliente: Rede de Restaurantes do Joe
- Profile Key 1: abc123... (unidade Downtown)
- Profile Key 2: xyz789... (unidade Seaside)

Ao publicar uma atualização especial de cardápio para a unidade Downtown, use a Profile Key 1 nas chamadas de API. Ao publicar sobre uma promoção de frutos do mar na unidade Seaside, use a Profile Key 2.

Ao criar múltiplos Perfis de Usuário, titulando ou marcando com tags apropriadamente e associando-os a um único usuário ou cliente no seu sistema, você pode gerenciar suas múltiplas contas de redes sociais nas mesmas plataformas usando a Ayrshare. Essa abordagem permite publicações direcionadas e recuperação de análises para cada conta específica.

Próximos Passos

Consulte aqui para mais detalhes sobre a experiência do usuário:

Integração do Usuário

Assim que seu usuário configurar seus links de redes sociais, você poderá começar a publicar em nome dele usando os endpoints /post e /profile.

Fluxo de Trabalho de Integração

Criar um Perfil de Usuário Ayrshare

Criar um Perfil com a API

Perfis

Criar um Perfil com o Dashboard (Equipe Interna)

Gerenciar Perfis de Usuário no Dashboard

Pacote de Integração

Single Sign-On com Autenticação JWT

Gerar um JWT

White-Label da Página de Conexão de Contas

White-Label da Página de Conexão de Contas

Logout Automático de uma Sessão de Perfil

Redirecionando ao Fechar

Mais Informações

Notificações de Vinculação ou Desvinculação de Usuário

Múltiplos Conjuntos de Contas Sociais

Visão Geral

Exemplo

Próximos Passos

Integração do Usuário

API de Post

API de Perfis

​Fluxo de Trabalho de Integração

​Criar um Perfil de Usuário Ayrshare

​Criar um Perfil com a API

Perfis

​Criar um Perfil com o Dashboard (Equipe Interna)

Gerenciar Perfis de Usuário no Dashboard

​Pacote de Integração

​Single Sign-On com Autenticação JWT

​Gerar um JWT

​White-Label da Página de Conexão de Contas

White-Label da Página de Conexão de Contas

​Logout Automático de uma Sessão de Perfil

​Abrindo e Fechando a URL de Vinculação Social

​Abrindo a URL de Vinculação Social

​Redirecionando ao Fechar

​Mais Informações

​Notificações de Vinculação ou Desvinculação de Usuário

​Múltiplos Conjuntos de Contas Sociais

​Visão Geral

​Exemplo

​Próximos Passos

Integração do Usuário

API de Post

API de Perfis

Fluxo de Trabalho de Integração

Criar um Perfil de Usuário Ayrshare

Criar um Perfil com a API

Criar um Perfil com o Dashboard (Equipe Interna)

Pacote de Integração

Single Sign-On com Autenticação JWT

Gerar um JWT

White-Label da Página de Conexão de Contas

Logout Automático de uma Sessão de Perfil

Abrindo e Fechando a URL de Vinculação Social

Abrindo a URL de Vinculação Social

Redirecionando ao Fechar

Mais Informações

Notificações de Vinculação ou Desvinculação de Usuário

Múltiplos Conjuntos de Contas Sociais

Visão Geral

Exemplo

Próximos Passos