Listings APIListings API
Accedi

Guida introduttiva

Crea il tuo account, aggiungi un metodo di pagamento, ottieni la tua chiave API ed effettua la tua prima chiamata alla Listings API.

Questa guida spiega come creare un account, ottenere la tua prima chiave API ed effettuare una richiesta alla Listings API.

1. Crea il tuo account

Scegli un piano nella pagina dei prezzi per aprire il modulo di registrazione, poi inserisci first name (nome), last name (cognome), work email (email aziendale) e company (azienda). Hai già un account? Accedi.

2. Aggiungi un metodo di pagamento

Dopo l'invio del modulo, ti reindirizziamo al nostro fornitore di servizi di pagamento per aggiungere una carta. La prova gratuita inizia subito e si converte nel piano che hai scelto al termine della prova, quindi annulla prima della scadenza se non vuoi ricevere addebiti. Le domande frequenti sui prezzi riportano la durata attuale della prova e i limiti dei piani.

3. Imposta la tua password e accedi

Una volta completata la procedura di pagamento, ti inviamo via email un link per impostare la password e attivare il tuo account. Dopo aver impostato la password, accedi con email e password oppure scegli Email me a sign-in link (inviami un link di accesso via email) per ricevere invece un link di accesso monouso.

4. Ottieni la tua chiave API

La tua prima chiave API viene generata automaticamente alla creazione dell'account; la trovi nella dashboard, nella sezione API Keys. Per crearne un'altra, scegli New key (nuova chiave), assegnale un nome e seleziona il livello di accesso (Read (lettura) o Write (scrittura)).

5. Effettua la tua prima richiesta

Autentica ogni richiesta con un'intestazione Authorization il cui valore è la stringa letterale API (nota lo spazio finale), seguita dalla tua chiave:

Shell
curl https://listingsapi.com/api/v4/locations \  -H "Authorization: API $LISTINGSAPI_KEY"

La risposta ha una struttura annidata anziché essere un semplice array: i risultati si trovano sotto data.allLocations, ogni record è un edges[].node e pageInfo contiene il cursore di paginazione e i totali.

JSON
{  "data": {    "allLocations": {      "edges": [        {          "cursor": "TG9jYXRpb246MTgwMDI4OQ==",          "node": {            "id": "TG9jYXRpb246MTgwMDI4OQ==",            "databaseId": 1800289,            "name": "Jenny Home",            "city": "Austin",            "stateIso": "TX",            "countryIso": "US"          }        }      ],      "pageInfo": {        "endCursor": "TG9jYXRpb246MTgwMDI4OQ==",        "hasNextPage": false,        "total": 1      }    }  }}

Per passare alla pagina successiva, invia nuovamente pageInfo.endCursor come ?after=… finché pageInfo.hasNextPage è true e interrompi la paginazione anche se una pagina viene restituita con un array edges vuoto. Ogni edge contiene anche il proprio cursor e il cursor dell'ultimo edge corrisponde al endCursor di quella pagina, quindi entrambi i valori possono essere usati come ?after=.

Non tutti gli endpoint di elenco gestiscono la paginazione allo stesso modo

La struttura edges / node / pageInfo riportata sopra segue lo stile a cursore Relay ed è solo una delle tre possibili:

  • Paginazione a cursore (first, after → edges[].node più pageInfo con endCursor / hasNextPage): sedi, ricerca delle sedi ed endpoint delle recensioni (interazioni per sede e riepilogo aggregato dell'account).
  • Paginazione con offset (page, perPage → un array records più pageInfo con totalRecords, totalPages, hasNextPage, hasPreviousPage): account collegati, suggerimenti di collegamento, post per una sede, post in blocco per una sede e riepilogo aggregato delle schede duplicate nell'intero account.
  • Array semplici, senza alcuna paginazione: gli endpoint del catalogo (sottocategorie, paesi e stati, siti del piano) e le foto di una sede.

Controlla l'esempio di risposta nella pagina dell'endpoint prima di scrivere un ciclo di paginazione; un ciclo a cursore applicato a un endpoint con offset legge una chiave edges che non è mai presente.

Passaggi successivi