Guia de integração

Esta página contém informações sobre diversas ferramentas e conceitos essenciais que você deve conhecer ao integrar os endpoints de mute ao seu sistema. Organizamos a página em algumas seções:

• Ferramentas úteis
• Conceitos essenciais
• Autenticação
• Portal do desenvolvedor, Projetos e Apps
• Limites de requisições
• Fields e expansions

​

Ferramentas úteis

Antes de abordarmos alguns conceitos fundamentais que ajudarão você a integrar este endpoint, recomendamos que você se familiarize com:

​

Postman

Postman é uma ótima ferramenta que você pode usar para testar um endpoint. Cada solicitação do Postman inclui todos os parâmetros de caminho e de corpo para ajudar você a entender rapidamente o que está disponível. Para saber mais sobre nossas coleções do Postman, visite nossa página “Usando o Postman”. 

​

Exemplos de código

Interessado em configurar este endpoint com código na sua linguagem de programação preferida? Temos diversos exemplos de código disponíveis que você pode usar como ponto de partida na nossa página no GitHub.

​

Bibliotecas de terceiros

Aproveite uma das bibliotecas de terceiros da nossa comunidade para começar. Você pode encontrar uma biblioteca compatível com os endpoints v2 procurando pela tag de versão adequada.

​

Conceitos essenciais

​

Autenticação

Todos os endpoints da X API v2 exigem que você autentique suas solicitações com um conjunto de credenciais, também conhecido como chaves e tokens. Você pode usar o Contexto de Usuário do OAuth 1.0a para autenticar suas solicitações a este endpoint. 

Contexto de Usuário do OAuth 1.0a, o que significa que você deve usar um conjunto de API Keys e Access Tokens de usuário para fazer uma solicitação com sucesso. Os access tokens devem estar associados ao usuário em nome de quem você está fazendo a solicitação. Se você quiser gerar um conjunto de Access Tokens para outro usuário, ele deverá autorizar seu App usando o fluxo OAuth de 3 etapas.

Observe que o OAuth 1.0a pode ser difícil de usar. Se você não estiver familiarizado com esse método de autenticação, recomendamos usar uma biblioteca ou uma ferramenta como o Postman.

​

Portal do desenvolvedor, Projetos e Apps de desenvolvedor

Para obter um conjunto de credenciais de autenticação compatível com os endpoints da X API v2, você deve inscrever-se em uma conta de desenvolvedor, configurar um Projeto nessa conta e criar um App de desenvolvedor dentro desse Projeto. Em seguida, você poderá encontrar suas chaves e tokens no seu App de desenvolvedor.  

​

Limites de requisições

Todos os dias, muitos milhares de desenvolvedores fazem requisições à X API. Para ajudar a gerenciar o grande volume dessas requisições, limites de requisições são aplicados a cada endpoint, restringindo o número de requisições que você pode fazer em nome do seu App ou de um usuário autenticado. 

Esses endpoints têm limites no nível do usuário, o que significa que o usuário autenticado em cujo nome você está fazendo a requisição só pode chamar o endpoint um determinado número de vezes em qualquer App de desenvolvedor. 

A tabela abaixo mostra os limites de requisições para cada endpoint.

Endpoint	método HTTP	limite de taxa
/2/users/:id/pinned_lists	POST	50 requisições por 15 minutos
/2/users/:id/pinned_lists/:list_id	DELETE	50 requisições por 15 minutos
/2/users/:id/pinned_lists	GET	15 requisições por 15 minutos

​

Fields e expansions

O endpoint GET da X API v2 permite que os usuários selecionem exatamente quais dados desejam retornar da API usando um conjunto de recursos chamados fields e expansions. O parâmetro expansions permite incluir, em formato expandido, objetos referenciados no payload. Por exemplo, consultar Lists fixadas permite obter as seguintes expansions:

• owner_id

O parâmetro fields permite selecionar exatamente quais fields dentro dos diferentes objetos de dados você deseja receber. Este endpoint retorna principalmente objetos de usuário. Por padrão, o objeto List retorna os campos id e name. Para receber campos adicionais, como list.created_at ou list.description, você precisará solicitá-los especificamente usando um parâmetro fields.

Adicionamos um guia sobre como usar fields e expansions em conjunto no nosso dicionário de dados da X API v2.

O quadro abaixo mostra os fields e expansions disponíveis para o endpoint de lookup:

Endpoint	Fields	Expansions
/2/users/:id/pinned_lists	list.fields user.fields	owner_id