Guia de início rápido

​

Introdução ao grupo de endpoints de gerenciamento de Lists

Esta visão geral rápida ajudará você a fazer sua primeira solicitação aos endpoints de gerenciamento de List 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.

Observação: Neste exemplo, faremos uma solicitação ao endpoint Create a List, mas você pode aplicar o que aprender nesta Introdução rápida a outras solicitações de gerenciamento também.

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:

• Inscreva-se para uma conta de desenvolvedor e aguarde a aprovação.
• Crie um Projeto e uma App de desenvolvedor associada no portal do desenvolvedor.
• Acesse a página “Keys and tokens” da sua App para gerar as credenciais necessárias. Certifique-se de salvar todas as credenciais em um local seguro.

​

Etapas para criar uma solicitação de gerenciamento de List

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 usaremos 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:

Adicionar X API v2 ao Postman

Depois de carregar a coleção do X API v2 no Postman, navegue até a pasta “List”, selecione a pasta “Manage List” e, em seguida, escolha “Create a List”.

Etapa dois: autentique sua solicitação

Para fazer corretamente uma solicitação ao X API, você precisa verificar se tem permissão para isso. Para fazer isso com os endpoints de gerenciamento de Posts, você deve autenticar sua solicitação usando OAuth 1.0a User Context ou OAuth 2.0 Authorization Code com PKCE.

Neste exemplo, vamos usar 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 da lista de ambientes).

Se você fez isso corretamente, essas variáveis serão automaticamente preenchidas na guia de autorização da solicitação.   Etapa três: especifique o nome da nova List

Ao criar uma nova List com este endpoint, o nome da List é um parâmetro obrigatório no corpo. Opcionalmente, você pode fornecer uma descrição e especificar se a List é privada.

No Postman, navegue até a guia “Body” e insira o nome da List como valor do parâmetro name. Além disso, se quiser adicionar uma descrição para a List, basta adicionar uma nova chave chamada description da mesma forma que name, seguida da descrição da List como valor. Tornar uma List privada seguirá o mesmo padrão, mas apenas valores true ou false são aceitos para esse parâmetro. 

Key	Value	Parameter type
name	Nome da List (obrigatório)	body
description	Descrição da List (opcional)	body
private	true ou false (opcional)	body

Agora você deverá ver uma URL semelhante ao lado do botão “Send”:

https://api.x.com/2/lists

Etapa quatro: faça sua solicitação e revise sua resposta

Depois que tudo estiver configurado, clique no botão “Send” e você receberá uma resposta semelhante ao exemplo a seguir:

{
  "data": {
    "id": "1441162269824405510",
    "name": "Nova lista criada do Postman"
  }
}

Se o objeto de resposta retornado contiver um id e o nome da sua List, você criou a List com sucesso. 

Para excluir uma List, selecione a solicitação “Delete a List”, também localizada na pasta “Lists” da coleção X API v2 carregada no Postman. Este endpoint requer o id da List que você deseja excluir. Na aba “Params”, insira o id da List que você deseja excluir como valor na coluna id. 

Em uma solicitação DELETE bem-sucedida, você receberá uma resposta semelhante ao seguinte exemplo:

{
  "data": {
    "deleted": true
  }
}