Skip to main content
POST
Crie uma URL de vinculação social para um User Profile. O endpoint continua se chamando generateJWT, mas o token que ele retorna é opaco e não é um JWT. Consulte a Visão geral da vinculação social para mais detalhes.
A URL de vinculação é válida por 5 minutos. Após 5 minutos, você deve gerar uma nova URL de vinculação. Consulte expiresIn do Max Pack para opções adicionais.
Este endpoint está obsoleto. Ele é totalmente suportado, não tem data de remoção e continua funcionando sem alteração — apenas não é mais a forma recomendada de criar uma URL de vinculação.O token retornado é uma string opaca que começa com ayr_ls_: não é um JWT decodificável e não carrega payload legível. Entregue a url ao seu usuário como ela é retornada e trate token como uma credencial que você armazena, não que inspeciona. Os links que você já criou continuam funcionando.POST /profiles/link-sessions faz a mesma operação sem os parâmetros legados e também permite consultar ou revogar um link. Veja Criar uma Link Session.

Parâmetros do cabeçalho

string
Sua X API Key (Consumer Key) do X Developer Portal. Alternativa ao parâmetro do corpo twitterApiKey. Quando fornecida, a URL de vinculação gerada usará seu X Developer App para vinculação OAuth.
string
Seu X API Secret (Consumer Secret) do X Developer Portal. Alternativa ao parâmetro do corpo twitterApiSecret. Obrigatório quando X-Twitter-OAuth1-Api-Key for fornecido.
Recomendado: passe suas credenciais do X pelos cabeçalhos (X-Twitter-OAuth1-Api-Key e X-Twitter-OAuth1-Api-Secret) para manter consistência com todos os outros endpoints da API do Ayrshare. Os parâmetros do corpo twitterApiKey e twitterApiSecret ainda são suportados para compatibilidade retroativa.

Parâmetros do corpo

string
Domínio do app. Use o domínio exato informado durante o onboarding.Opcional. Se omitido, o domínio da sua própria conta é usado. Se você enviá-lo, precisa ser um domínio registrado na sua conta.
string
obsoleto
Não é mais usado. O campo é aceito e ignorado, então integrações existentes continuam funcionando sem alteração.As URLs de vinculação não são mais assinadas, portanto não há chave a enviar. Você pode remover este campo e parar de armazenar a chave privada para essa finalidade.
string
obrigatório
User Profile Key. A API Key não pode ser usada neste campo.
boolean
padrão:false
Fazer logout automático da sessão atual. Recomendamos não usar em produção, pois afeta o desempenho.Consulte Logout automático de uma sessão de profile para mais informações.
string
Especifique uma URL para redirecionar quando o botão “Done” ou a imagem do logotipo forem clicados. A URL será automaticamente encurtada na URL de vinculação retornada. Redirecione a janela de origem adicionando o parâmetro de consulta origin=true à URL de redirecionamento.
array
Especifique as redes sociais a serem exibidas na página de vinculação. Isso sobrescreverá as redes sociais configuradas na página Social Networks.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
Sobrescreve qual fluxo de vinculação do Instagram é usado quando um usuário clica no botão do Instagram na página de vinculação de contas sociais para esta URL. Valores válidos:
  • instagram: Instagram Login direto, sem necessidade de Página do Facebook.
  • facebook: Vincular o Instagram por meio de uma Página do Facebook conectada.
Force direct Instagram Login for this linking session
Quando omitido, a página de vinculação usa a configuração de Instagram Login em nível de conta.Consulte Método de vinculação do Instagram para mais informações.
boolean
obsoleto
Não é mais usado. O campo é aceito e ignorado.Não há token assinado a verificar: o token retornado é validado pela página de vinculação quando seu usuário abre a URL.
boolean
obsoleto
Não é mais usado. O campo é aceito e ignorado, já que privateKey não é mais lido.
number
padrão:5
Defina a longevidade do token em minutos. Intervalo: 1 minuto a 2880 minutos.Consulte Expiração do link para mais informações.
object
Envie um e-mail Connect Accounts com um link para os usuários acessarem diretamente sua página de vinculação de contas sociais.Se o e-mail não puder ser enviado, você ainda recebe o link. A resposta traz emailSent: false e um objeto emailError, para que você possa enviar o link ao seu usuário de outra forma.Consulte E-mail de conexão de contas para mais informações.
Quando você inclui suas credenciais da X API, a URL de vinculação gerada iniciará a vinculação OAuth usando seu próprio X Developer App. Seus usuários finais verão o nome do seu app na tela de consentimento do X.
Obrigatório: antes de usar este recurso, adicione estas URLs de callback nas configurações do seu X Developer App (em Authentication settings > Callback URI / Redirect URL):
  • https://profile.ayrshare.com/social-accounts
  • https://app.ayrshare.com/social-accounts
Sem elas, o fluxo OAuth falhará com um erro 403 Callback URL not approved.