入門指南
建立您的帳戶、新增付款方式、取得 API 金鑰,並首次呼叫 Listings API。
本指南說明如何建立帳戶、取得您的第一把 API 金鑰,以及向 Listings API 發出請求。
1. 建立您的帳戶
在價格頁面選擇方案以開啟註冊表單,然後輸入您的名字、姓氏、工作電子郵件地址和公司名稱。您已經有帳戶了嗎?請直接登入。
2. 新增付款方式
您提交表單後,我們會將您導向我們的付款服務供應商,以新增付款卡片。您的免費試用會立即開始,並在試用結束後轉為您選擇的方案,因此若您不想被收費,請在試用結束前取消。價格常見問題提供目前的試用期限和方案限制。
3. 設定密碼並登入
結帳完成後,我們會透過電子郵件寄送連結給您,讓您設定密碼並啟用帳戶。設定密碼後,請使用您的電子郵件地址和密碼登入,或選擇 Email me a sign-in link(透過電子郵件寄送登入連結給我),改為接收一次性免密碼登入連結。
4. 取得您的 API 金鑰
建立帳戶時,系統會自動核發您的第一把 API 金鑰,您可以在儀表板的 API Keys 區段找到它。若要建立另一把金鑰,請選擇 New key(新增金鑰),為其命名,並選擇存取層級(Read(讀取)或 Write(寫入))。
5. 發出您的第一個請求
每個請求都必須以 Authorization 標頭驗證,其值為字面字串 API (請注意結尾的空格),後面接上您的金鑰:
curl https://listingsapi.com/api/v4/locations \ -H "Authorization: API $LISTINGSAPI_KEY"回應採用巢狀結構,而非單純的陣列:結果位於 data.allLocations 下,每筆記錄都是一個 edges[].node,而 pageInfo 包含分頁游標和總數。
{ "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 } } }}若要取得下一頁,請在 pageInfo.hasNextPage 為 true 時,將 pageInfo.endCursor 作為 ?after=… 傳入;如果某一頁傳回的 edges 陣列為空,也應停止。每個 edge 也都包含自己的 cursor,而最後一個 edge 的 cursor 就是該頁的 endCursor,因此這兩個值都可以用作 ?after=。
並非所有清單端點都使用相同的分頁方式
上述 edges/node/pageInfo 結構採用 Relay 游標樣式,這只是 3 種分頁方式之一:
- 游標分頁(
first、after→edges[].node,加上含有endCursor/hasNextPage的pageInfo):地點、地點搜尋,以及評論端點(個別地點的互動和帳戶彙總)。 - 位移量分頁(
page、perPage→records陣列,加上含有totalRecords、totalPages、hasNextPage、hasPreviousPage的pageInfo):已連結帳戶、連線建議、個別地點的貼文、個別地點的大量貼文,以及整個帳戶內的重複商家資訊彙總。 - 純陣列,完全不分頁:目錄端點(子類別、國家與州、方案網站),以及個別地點的相片。
撰寫分頁迴圈前,請先查看該端點專屬頁面上的回應範例;對採用位移量分頁的端點使用游標迴圈,會讀取根本不存在的 edges 鍵。