Vai al contenuto principale

Introduzione all’endpoint di lookup delle List

Questo Avvio rapido ti guiderà nell’effettuare la tua prima richiesta all’endpoint di lookup delle List utilizzando Postman. Visita il nostro repository GitHub X API v2 sample code se vuoi vedere esempi di codice in diverse lingue. Nota: In questo esempio effettueremo una richiesta all’endpoint List lookup by ID, ma puoi applicare quanto impari in questo Avvio rapido anche ad altre richieste di lookup.

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 ottieni l’approvazione.
  • Crea un Project e una developer App 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 lookup di una List

Primo passaggio: iniziare con uno strumento o una libreria Esistono diversi strumenti, esempi di codice e librerie che puoi utilizzare per inviare una richiesta a questo endpoint, ma qui useremo Postman per semplificare il processo. Per caricare nel tuo ambiente la collection Postman di X API v2, fai clic sul seguente pulsante: Una volta caricata la collection X API v2 in Postman, vai alla cartella “List”, seleziona la cartella “List lookup” e poi scegli “List by ID”.   Secondo passaggio: autentica la tua richiesta Per effettuare correttamente una richiesta alla X API, devi verificare di avere l’autorizzazione. Per farlo con questo endpoint, devi autenticare la richiesta con uno dei seguenti metodi: App onlyOAuth 2.0 Authorization Code with PKCEOAuth 1.0a User Context. Per semplicità, utilizzeremo App only per questa richiesta, ma se desideri richiedere metriche private o List, dovrai usare uno degli altri metodi di autenticazione.  Per utilizzare App only, devi aggiungere le tue chiavi e token (in particolare l’App only Access Token) a Postman selezionando l’ambiente denominato “X API v2” (nell’angolo in alto a destra di Postman) e aggiungendo le tue 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: identifica e specifica quale List desideri recuperare Devi specificare la List che desideri ottenere nella richiesta. Puoi trovare l’ID della List navigando su x.com, facendo clic su una List e poi controllando l’URL. Ad esempio, l’ID della List del seguente URL è 84839422. https://x.com/i/lists/84839422 L’ID di destinazione può essere qualsiasi ID valido di una List. In Postman, vai alla scheda “Params” e inserisci il tuo ID nella colonna “Value” della variabile di percorso id. Assicurati di non includere spazi prima o dopo l’ID.
KeyValue
id84839422 (L’ID della List)
Quarto passaggio: identifica e specifica quali fields desideri recuperare Se fai clic sul pulsante “Send” dopo il terzo passaggio, riceverai nella risposta i fields predefiniti del List object: id, name. Se desideri ricevere fields aggiuntivi, dovrai specificarli nella richiesta con i parametri list.fields e/o expansions. Per questo esercizio, richiederemo tre insiemi aggiuntivi di fields da oggetti diversi:
  • Il field aggiuntivo created_at nell’oggetto principale List.
  • Il user object completo usando il parametro expansions
  • Il field aggiuntivo user.created_at nell’oggetto utente associato.
In Postman, vai alla scheda “Params” e aggiungi la seguente coppia chiave:valore alla tabella “Query Params”:
KeyValueReturned fields
list.fieldscreated_atcreated_at
expansionsowner_idincludes.users.id,
includes.users.name,
includes.users.username
user.fieldscreated_atincludes.users.created_at
Ora dovresti vedere un URL simile accanto al pulsante “Send”: https://api.x.com/2/lists/84839422?list.fields=owner_id&expansions=owner_id&user.fields=created_at Quinto passaggio: invia la tua richiesta e verifica la risposta Dopo aver configurato tutto, premi il pulsante “Send” e riceverai una risposta simile al seguente esempio:
{
  "data": {
    "id": "84839422",
    "name": "Account Twitter ufficiali",
    "owner_id": "783214"
  },
  "includes": {
    "users": [
      {
        "name": "Twitter",
        "created_at": "2007-02-20T14:35:54.000Z",
        "username": "Twitter",
        "id": "783214"
      }
    ]
  }
}
I