Guida rapida

​

Introduzione al gruppo di endpoint per la gestione delle List

Questa breve panoramica ti aiuterà a inviare la tua prima richiesta agli endpoint per la gestione delle List utilizzando Postman.

Se desideri consultare esempi di codice in diverse lingue, visita il nostro repository GitHub X API v2 sample code.

Nota: In questo esempio invieremo una richiesta all’endpoint Create a List, ma puoi applicare quanto imparato in questo Avvio rapido anche ad altre richieste di gestione.

Prerequisiti

Per completare questa guida, avrai bisogno di un set di chiavi e token per autenticare la tua richiesta. Puoi generare queste chiavi e token seguendo questi passaggi:

• Registrati per un account sviluppatore e attendi l’approvazione.
• Crea un Project e un’App sviluppatore associata nel developer portal.
• Vai alla pagina “Keys and tokens” della tua App per generare le credenziali richieste. Assicurati di salvare tutte le credenziali in un luogo sicuro.

​

Passaggi per creare una richiesta di gestione List

Primo passaggio: inizia con uno strumento o una libreria

Esistono diversi strumenti, esempi di codice e librerie che puoi usare per effettuare una richiesta a questo endpoint, ma qui utilizzeremo Postman per semplificare il processo.

Per caricare la raccolta Postman di X API v2 nel tuo ambiente, fai clic sul seguente pulsante:

Aggiungi X API v2 a Postman

Una volta caricata la raccolta X API v2 in Postman, vai alla cartella “List”, seleziona la cartella “Manage List” e poi scegli “Create a List”.

Secondo passaggio: autentica la tua richiesta

Per effettuare correttamente una richiesta alla X API, devi verificare di avere l’autorizzazione a farlo. Per farlo con gli endpoint di gestione dei Post, devi autenticare la richiesta usando OAuth 1.0a User Context o OAuth 2.0 Authorization Code with PKCE.

In questo esempio, utilizzeremo OAuth 1.0a User Context.

Devi aggiungere le tue chiavi e i tuoi token (in particolare la tua API Key, la tua Secret API Key, l’OAuth 1.0a user Access Token e l’OAuth 1.0a user Access Token Secret) a Postman. Puoi farlo selezionando l’ambiente denominato “X API v2” (nell’angolo in alto a destra di Postman) e aggiungendo chiavi e token ai campi “initial value” e “current value” (facendo clic sull’icona a forma di occhio accanto al menu a discesa dell’ambiente).

Se l’hai fatto correttamente, queste variabili verranno automaticamente inserite nella scheda di autorizzazione della richiesta.   Terzo passaggio: specifica il nome per la nuova List

Quando crei una nuova List con questo endpoint, il nome della List è un parametro del body obbligatorio. Facoltativamente, puoi fornire una descrizione e specificare se la List è privata.

In Postman, vai alla scheda “Body” e inserisci il nome della List come valore per il parametro name. Inoltre, se desideri aggiungere una descrizione per la List, aggiungi una nuova chiave denominata description nello stesso modo di name, seguita dalla descrizione della List come valore. Rendere una List privata segue lo stesso schema, ma per questo parametro sono accettati solo i valori true o false. 

Key	Value	Parameter type
name	Nome della List (obbligatorio)	body
description	Descrizione della List (facoltativo)	body
private	true o false (facoltativo)	body

Ora dovresti vedere un URL simile accanto al pulsante “Send”:

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

Quarto passaggio: effettua la richiesta e verifica la risposta

Una volta configurato tutto, premi il pulsante “Send” e riceverai una risposta simile al seguente esempio:

{
  "data": {
    "id": "1441162269824405510",
    "name": "Nuova lista creata da Postman"
  }
}

Se l’oggetto di risposta contiene un id e il nome della tua List, la List è stata creata correttamente. 

Per eliminare una List, seleziona la richiesta “Delete a List” presente anche nella cartella “Lists” della collection X API v2 caricata in Postman. Questo endpoint richiede l’id della List che desideri eliminare. Nella scheda “Params”, inserisci l’id della List da eliminare come valore per la colonna id. 

Se la richiesta di eliminazione va a buon fine, riceverai una risposta simile al seguente esempio:

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