Panduan memulai

Buat akun Anda, tambahkan metode pembayaran, dapatkan kunci API Anda, dan lakukan panggilan Listings API pertama Anda.

Panduan ini menjelaskan cara membuat akun, mendapatkan kunci API pertama Anda, dan mengirim permintaan ke Listings API.

Akses harian sandbox

Saat akses harian sandbox ditawarkan, Anda dapat mendaftar dengan nama, email, dan perusahaan Anda, tanpa kartu atau kata sandi, serta menggunakan API dan server MCP yang sama selama 24 jam. Kami mengirimkan tautan dan kode 6 digit kepada Anda melalui email. Akun Anda baru dibuat dan periode 24 jam Anda baru dimulai saat Anda membuka tautan lalu menekan Start my day pass (Mulai akses harian saya), atau saat kode tersebut digunakan, sehingga agen AI dapat memulai akses harian untuk Anda menggunakan kode itu. Akun sandbox dapat menampung hingga 2 lokasi, mencakup endpoint lokasi dan profil bisnis, serta menyinkronkan profil bisnisnya hanya ke direktori demo listingsAPI, tidak pernah ke platform publikasi yang sebenarnya. Setelah 24 jam berakhir, kunci API akun tersebut berhenti berfungsi, dan Anda memiliki waktu 48 jam untuk mendaftar ke Launch atau Growth dengan email yang sama sebelum akun sandbox beserta datanya dihapus. Akses harian tidak menggunakan kata sandi, jadi untuk masuk kembali, pilih Email me a sign-in link (Kirim tautan masuk melalui email kepada saya) di halaman masuk. Panduan akses harian memuat perincian lengkap, termasuk panggilan yang dilakukan agen.

1. Buat akun Anda

Pilih paket di halaman harga untuk membuka formulir pendaftaran, lalu masukkan first name (nama depan), last name (nama belakang), work email (email kantor), dan company (perusahaan) Anda. Sudah memiliki akun? Silakan masuk.

2. Tambahkan metode pembayaran

Setelah Anda mengirim formulir, kami mengarahkan Anda ke penyedia layanan pembayaran kami untuk menambahkan kartu. Uji coba gratis Anda langsung dimulai dan beralih ke paket yang Anda pilih saat uji coba berakhir, jadi batalkan sebelum waktu tersebut jika Anda tidak ingin dikenai biaya. FAQ harga memuat durasi uji coba dan batas paket yang berlaku saat ini.

Setelah proses checkout selesai, kami mengirimkan tautan melalui email kepada Anda untuk menetapkan kata sandi dan mengaktifkan akun Anda. Setelah kata sandi Anda ditetapkan, masuk dengan email dan kata sandi Anda, atau pilih Email me a sign-in link (Kirim tautan masuk melalui email kepada saya) untuk menerima tautan masuk sekali pakai sebagai gantinya.

4. Dapatkan kunci API Anda

Kunci API pertama Anda diterbitkan secara otomatis saat akun Anda dibuat; temukan kunci tersebut di dasbor pada bagian API Keys. Untuk membuat kunci lain, pilih New key (Kunci baru), beri nama, lalu pilih tingkat aksesnya (Read (Baca) atau Write (Tulis)).

5. Kirim permintaan pertama Anda

Autentikasi setiap permintaan dengan header Authorization yang nilainya berupa string literal API (perhatikan spasi di akhir), diikuti kunci Anda:

Shell

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

Respons menggunakan struktur bersarang, bukan sekadar array: hasil berada di bawah data.allLocations, setiap rekaman merupakan edges[].node, dan pageInfo memuat kursor paginasi serta jumlah total.

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      }    }  }}

Untuk beralih ke halaman berikutnya, kirim kembali pageInfo.endCursor sebagai ?after=… selama pageInfo.hasNextPage bernilai true, dan berhenti juga jika suatu halaman dikembalikan dengan array edges yang kosong. Setiap edge juga memuat cursor miliknya sendiri, dan cursor dari edge terakhir merupakan endCursor halaman tersebut, sehingga salah satu dari kedua nilai itu dapat digunakan sebagai ?after=.

Tidak semua endpoint daftar menggunakan paginasi yang sama

Struktur edges / node / pageInfo di atas menggunakan gaya kursor Relay, yang hanya merupakan satu dari tiga gaya:

Paginasi kursor (first, after → edges[].node serta pageInfo dengan endCursor / hasNextPage): lokasi, pencarian lokasi, dan endpoint ulasan (interaksi per lokasi dan rekap tingkat akun).
Paginasi offset (page, perPage → array records serta pageInfo dengan totalRecords, totalPages, hasNextPage, hasPreviousPage): akun yang terhubung, saran koneksi, postingan untuk suatu lokasi, postingan massal untuk suatu lokasi, dan rekap profil bisnis duplikat di seluruh cakupan satu akun.
Array biasa, tanpa paginasi sama sekali: endpoint katalog (subkategori, negara dan negara bagian, situs dalam paket) dan foto suatu lokasi.

Periksa contoh respons di halaman endpoint itu sendiri sebelum menulis perulangan paginasi; perulangan kursor yang digunakan pada endpoint offset membaca kunci edges yang tidak pernah ada.

Langkah selanjutnya

Akses harian sandbox: coba lokasi dan profil bisnis tanpa memerlukan kartu. Anda atau agen AI Anda dapat memulainya.
Autentikasi: header kunci API dan rotasi kunci.
Kode kesalahan: kode status HTTP dan struktur respons kesalahan.
SDK: klien Python dan Node dengan informasi tipe.