Pular para o conteúdo principal
POST
Gere um JSON Web Token (JWT) para uso com single sign on. Consulte a Visão geral do Generate JWT para mais detalhes.
A URL do JWT é válida por 5 minutos. Após 5 minutos, você deve gerar uma nova URL de JWT. Consulte expiresIn do Max Pack para opções adicionais.

Parâmetros do cabeçalho

X-Twitter-OAuth1-Api-Key
string
Sua X API Key (Consumer Key) do X Developer Portal. Alternativa ao parâmetro do corpo twitterApiKey. Quando fornecida, a URL do JWT gerada usará seu X Developer App para vinculação OAuth.
X-Twitter-OAuth1-Api-Secret
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

domain
string
obrigatório
Domínio do app. Use o domínio exato informado durante o onboarding.
privateKey
string
obrigatório
Private Key usada para criptografia.
profileKey
string
obrigatório
User Profile Key. A API Key não pode ser usada neste campo.
logout
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.
redirect
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 do JWT retornada. Redirecione a janela de origem adicionando o parâmetro de consulta origin=true à URL de redirecionamento.
allowedSocial
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.
verify
boolean
padrão:false
Verifica se o token gerado é válido. Recomendamos usar apenas em ambientes fora de produção.Consulte Abrindo e fechando a URL de vinculação de contas sociais para mais informações.
base64
boolean
padrão:false
Se a private key estiver codificada em base64, defina como true.Codifique o arquivo private.key em base64 e passe a String de uma linha no campo privateKey.Por exemplo, no Linux: cat private.key | base64
expiresIn
number
padrão:5
Defina a longevidade do token em minutos. Intervalo: 1 minuto a 2880 minutos.Consulte JWT Expires In para mais informações.
email
object
padrão:5
Envie um e-mail Connect Accounts com um link para os usuários acessarem diretamente sua página de vinculação de contas sociais.Consulte E-mail de conexão de contas para mais informações.
Quando você inclui suas credenciais da X API, a URL do JWT 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.