Vai al contenuto principale

Guida introduttiva agli endpoint di lookup di Spaces

Questa guida di Avvio rapido ti aiuterà a inviare la tua prima richiesta a uno degli endpoint di lookup di Spaces con un set di fields specificati utilizzando Postman. Se desideri vedere esempi di codice in diversi linguaggi di programmazione, visita il nostro repository X API v2 sample code GitHub.

Prerequisiti

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

Passaggi per creare una richiesta di lookup di Spaces

Per questo esempio effettueremo una richiesta all’endpoint di lookup delle Spaces dell’utente per creator ID, ma puoi applicare quanto imparato da questo Avvio rapido anche ad altre richieste di lookup. Primo passaggio: inizia con uno strumento o una libreria Esistono diversi strumenti, esempi di codice e librerie che puoi utilizzare per effettuare una richiesta a questo endpoint, ma qui useremo lo strumento Postman per semplificare il processo. Per caricare la collection Postman di X API v2 nel tuo ambiente, fai clic sul seguente pulsante: Una volta caricata la collection X API v2 in Postman, vai alla cartella Spaces e trova la richiesta “Lookup Spaces created by one or more users”.   Secondo passaggio: autentica la tua richiesta Per effettuare correttamente una richiesta alla X API, devi verificare di avere l’autorizzazione. A tal fine, questo endpoint richiede di autenticare la richiesta con uno dei metodi di autenticazione OAuth 2.0 App-Only o OAuth 2.0 Authorization Code con PKCE. Per semplicità, utilizzeremo OAuth 2.0 App-Only con questa richiesta, ma dovrai usare uno degli altri metodi di autenticazione se desideri richiedere metriche private o Spaces da un utente con account privato.  Per usare OAuth 2.0 App-Only, devi aggiungere le tue chiavi e token, in particolare l’App Access Token (noto anche come App-only Bearer Token) a Postman. Puoi farlo 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). Queste variabili verranno automaticamente inserite nella scheda di autorizzazione della richiesta se hai eseguito correttamente questa operazione.   Terzo passaggio: identifica e specifica da quale utente desideri recuperare i Post Devi specificare un utente per il quale desideri recuperare Spaces in diretta o imminenti all’interno della richiesta. In questo esempio passeremo un singolo user ID. Gli user ID sono semplicemente il valore numerico che rappresenta l’handle di un account e che puoi trovare nell’URL del profilo di un account. Ad esempio, il nome utente del seguente account è XDevelopers. https://x.com/XDevelopers Per convertire questo username nello user ID, dovrai utilizzare l’endpoint di user lookup con lo username e trovare lo user ID numerico nel payload. Nel caso di @XDevelopers, lo user ID è 2244994945. In Postman, vai alla scheda “Params” e inserisci questo user ID nella colonna “Value” del parametro id.
KeyValue
id2244994945
Quarto passaggio: identifica e specifica quali fields desideri recuperare Se fai clic sul pulsante “Send” dopo il terzo passaggio, riceverai un id, che è l’unico field dello Space object restituito per impostazione predefinita nella tua risposta. Se desideri ricevere fields aggiuntivi, dovrai specificarli nella tua richiesta con i parametri space.fields o expansions. Per questo esercizio, richiederemo tre set aggiuntivi di fields da oggetti diversi:
  • Il field title aggiuntivo nell’oggetto Spaces primario.
  • Il user object completo del creator ID specificato
  • Il field user.created_at aggiuntivo nell’oggetto utente associato.
In Postman, vai alla scheda “Params” e aggiungi la seguente coppia chiave:valore alla tabella “Query Params”:
KeyValueReturned fields
space.fieldstitlecreator_id
expansionscreator_idincludes.users.id, includes.users.name, includes.users.username
user.fieldscreated_atincludes.users.created_at
Ora dovresti vedere il seguente URL accanto al pulsante “Send”: https://api.x.com/2/spaces/by/creator_ids?user_ids=2244994945&space.fields=creator_id&expansions=creator_id&user.fields=created_at Passaggio cinque: inviare la richiesta e verificare la risposta Una volta completata la configurazione, fare clic sul pulsante “Send” per ricevere la seguente risposta:
{
   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "Ciao mondo 👋",
        "state": "Running"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}
I