Listings APIListings API
Oturum aç

Başlangıç

Hesabınızı oluşturun, ödeme bilgilerinizi ekleyin, API anahtarınızı alın ve ilk Listings API çağrınızı yapın.

Bu kılavuz, hesap oluşturmayı, ilk API anahtarınızı almayı ve Listings API'ye istek göndermeyi açıklar.

1. Hesabınızı oluşturun

Kayıt formunu açmak için fiyatlandırma sayfasında bir plan seçin, ardından first name (ad), last name (soyad), work email (iş e-postası adresi) ve company (şirket) alanlarını doldurun. Zaten bir hesabınız var mı? Bunun yerine oturum açın.

2. Ödeme bilgilerinizi ekleyin

Formu gönderdikten sonra kart eklemeniz için sizi ödeme sağlayıcımıza yönlendiririz. Ücretsiz denemeniz hemen başlar ve deneme süresi sona erdiğinde seçtiğiniz plana dönüşür; bu nedenle ücretlendirilmek istemiyorsanız bu süre dolmadan iptal edin. Güncel deneme süresi ve plan sınırları fiyatlandırma SSS'sinde yer alır.

3. Parolanızı belirleyin ve oturum açın

Ödeme işlemi tamamlandığında, parolanızı belirlemeniz ve hesabınızı etkinleştirmeniz için size e-postayla bir bağlantı göndeririz. Parolanızı belirledikten sonra e-posta adresiniz ve parolanızla oturum açın veya bunun yerine tek kullanımlık bir oturum açma bağlantısı almak için Email me a sign-in link (Bana e-postayla oturum açma bağlantısı gönder) seçeneğini seçin.

4. API anahtarınızı alın

İlk API anahtarınız hesabınız oluşturulduğunda otomatik olarak verilir; bu anahtarı kontrol panelindeki API Keys bölümünde bulabilirsiniz. Başka bir anahtar oluşturmak için New key (Yeni anahtar) seçeneğini seçin, anahtara bir ad verin ve erişim düzeyini seçin (Read (Okuma) veya Write (Yazma)).

5. İlk isteğinizi gönderin

Her isteğin kimlik doğrulamasını, değeri tam olarak API dizesi (sondaki boşluğa dikkat edin) ve hemen ardından anahtarınızdan oluşan bir Authorization üstbilgisiyle yapın:

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

Yanıt, yalın bir dizi yerine iç içe bir yapıdadır: sonuçlar data.allLocations altında yer alır, her kayıt bir edges[].node öğesidir ve pageInfo, sayfalama imlecini ve toplamları içerir.

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

Sonraki sayfaya geçmek için pageInfo.hasNextPage değeri true olduğu sürece pageInfo.endCursor değerini ?after=… olarak geri gönderin; bir sayfa boş bir edges dizisiyle dönerse de durun. Her edge ayrıca kendi cursor değerini içerir ve son edge'in cursor değeri o sayfanın endCursor değeridir; bu nedenle her iki değer de ?after= olarak kullanılabilir.

Her liste uç noktası aynı şekilde sayfalama yapmaz

Yukarıdaki edges / node / pageInfo yapısı, Relay cursor stilindedir ve üç sayfalama biçiminden yalnızca biridir:

  • Cursor tabanlı sayfalama (first, after → edges[].node ve endCursor / hasNextPage içeren pageInfo): konumlar, konum araması ve yorum uç noktaları (konum başına etkileşimler ve hesap genelindeki toplu görünüm).
  • Offset tabanlı sayfalama (page, perPage → bir records dizisi ve totalRecords, totalPages, hasNextPage, hasPreviousPage içeren pageInfo): bağlı hesaplar, bağlantı önerileri, bir konumun gönderileri, bir konumun toplu gönderileri ve hesap genelindeki yinelenen işletme kayıtlarının toplu görünümü.
  • Düz diziler, hiçbir sayfalama olmadan: katalog uç noktaları (alt kategoriler, ülkeler ve eyaletler, plan kapsamındaki siteler) ve bir konumun fotoğrafları.

Bir sayfalama döngüsü yazmadan önce uç noktanın kendi sayfasındaki yanıt örneğini kontrol edin; offset tabanlı bir uç noktaya yönelik cursor döngüsü, yanıtta hiçbir zaman bulunmayan bir edges anahtarını okumaya çalışır.

Sonraki adımlar

  • Sandbox günlük erişim: kart gerekmeden konumları ve işletme kayıtlarını deneyin. Siz veya yapay zekâ ajanınız bu erişimi başlatabilirsiniz.
  • Kimlik doğrulama: API anahtarı üstbilgileri ve anahtar rotasyonu.
  • Hata kodları: HTTP durum kodları ve hata yanıtının yapısı.
  • SDK'ler: tür tanımları içeren Python ve Node istemcileri.