Pular para o conteúdo principal

Introdução aos endpoints de gerenciamento de follows

Este guia de introdução rápida ajudará você a fazer sua primeira solicitação aos endpoints de gerenciamento de follows usando o Postman. Se você quiser ver exemplos de código em diferentes linguagens, visite nosso repositório no GitHub: X API v2 sample code

Pré-requisitos

Para concluir este guia, você precisará de um conjunto de chaves e tokens para autenticar sua solicitação. Você pode gerar essas chaves e tokens seguindo estas etapas:

Etapas para construir uma solicitação de gerenciamento de follows

Etapa um: comece com uma ferramenta ou biblioteca

Há várias ferramentas, exemplos de código e bibliotecas que você pode usar para fazer uma solicitação a este endpoint, mas aqui vamos usar o Postman para simplificar o processo. Para carregar a coleção do X API v2 do Postman no seu ambiente, clique no botão a seguir: Depois que a coleção do X API v2 estiver carregada no Postman, navegue até a pasta “Follows” e selecione “Follow a user ID”.  

Etapa dois: autentique sua solicitação

Para fazer uma solicitação corretamente à X API, você precisa verificar se tem permissão. Para isso, neste endpoint, você deve autenticar sua solicitação usando OAuth 1.0a User Context ou OAuth 2.0 Authorization Code with PKCE. Neste exemplo, usaremos OAuth 1.0a User Context. Você deve adicionar suas chaves e tokens — especificamente sua API Key, Chave secreta da API, OAuth 1.0a user Access Token e OAuth 1.0a user Access Token Secret — ao Postman. Você pode fazer isso selecionando o ambiente chamado “X API v2” no canto superior direito do Postman e adicionando suas chaves e tokens aos campos “initial value” e “current value” (clicando no ícone de olho ao lado do menu suspenso de ambiente). Essas variáveis serão automaticamente carregadas na guia de autorização da solicitação se você tiver feito tudo corretamente.  

Etapa três: Especifique quem vai seguir quem

Os endpoints de gerenciamento de follows aceitam dois IDs: um para o usuário de origem (o usuário que deseja seguir ou deixar de seguir outro usuário) e outro para o usuário de destino (o usuário que será seguido ou deixará de ser seguido). O ID do usuário de origem deve corresponder ao ID do usuário autenticado. Neste caso, você pode especificar o ID do seu próprio usuário. Você pode encontrar seu ID de duas maneiras:
  1. Usando o endpoint user lookup by username, você pode informar um nome de usuário e receber o campo id.
  2. Verificando seu Access Token, você verá que a parte numérica é o seu ID de usuário.
O ID de destino pode ser qualquer ID de usuário válido. Por exemplo, o ID de usuário de @XDevelopers é 2244994945. No Postman, navegue até a aba “Params” e insira seu ID na coluna “Value” da variável de caminho id. Vá até a aba “Body” e informe 2244994945 (o ID de usuário de @XDevelopers) como valor para o parâmetro target_user_id. Certifique-se de não incluir espaços antes ou depois de nenhum ID.
KeyValue
id(seu ID de usuário)
target_user_id2244994945
Ao clicar no botão “Send”, você receberá um objeto de resposta contendo o status do relacionamento:
  • Se você receber “following”: true, então o id está seguindo com sucesso o target_user_id.
  • Se você receber “pending”: true, então o target_user_id é protegido e deve aceitar sua solicitação de follow.

Etapa quatro: faça sua requisição e revise a resposta Depois que tudo estiver configurado, clique no botão “Send” e você receberá a seguinte resposta:
    "data": {
        "following": true,
        "pending_follow": false
    }
}
Da mesma forma, se você estivesse tentando deixar de seguir um usuário, usaria a requisição “Unfollow a user ID” na mesma coleção do Postman. No entanto, os parâmetros source_user_id e target_user_id devem ser passados como variáveis de caminho ao usar o endpoint de unfollow.
I