Başlarken
Hesabınızı oluşturun, ödeme yöntemi 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ından bir plan seçin, ardından adınızı, soyadınızı, iş e-posta adresinizi ve şirketinizi girin. Zaten bir hesabınız var mı? Bunun yerine oturum açın.
2. Ödeme bilgilerini 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 geçer; bu nedenle ücret alınmasını istemiyorsanız bu süre dolmadan iptal edin. Güncel deneme süresi ve plan sınırları fiyatlandırma hakkında sık sorulan sorularda 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
Hesabınız oluşturulduğunda ilk API anahtarınız otomatik olarak oluşturulur; 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 belirleyin (Read (Okuma) veya Write (Yazma)).
5. İlk isteğinizi gönderin
Her isteğin kimliğini, değeri tam olarak API dizesiyle (sondaki boşluğa dikkat edin) başlayıp anahtarınızla devam eden bir Authorization üst bilgisiyle doğrulayın:
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.
{ "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 bu iki değerden herhangi biri ?after= olarak kullanılabilir.
Her liste uç noktası aynı sayfalama yöntemini kullanmaz
Yukarıdaki edges / node / pageInfo yapısı, Relay imleç stilindedir ve üç sayfalama biçiminden yalnızca biridir:
- İmleç tabanlı sayfalama (
first,after→edges[].nodeveendCursor/hasNextPageiçerenpageInfo): konumlar, konum araması ve yorum uç noktaları (konum başına etkileşimler ve hesap genelindeki toplu özet). - Ofset tabanlı sayfalama (
page,perPage→ birrecordsdizisi vetotalRecords,totalPages,hasNextPage,hasPreviousPageiçerenpageInfo): 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 özeti. - Düz diziler, sayfalama içermez: katalog uç noktaları (alt kategoriler, ülkeler ve eyaletler, plana dahil siteler) ve bir konumun fotoğrafları.
Sayfalama döngüsü yazmadan önce uç noktanın kendi sayfasındaki yanıt örneğini kontrol edin; ofset tabanlı bir uç noktada çalışan imleç döngüsü, yanıtta hiçbir zaman bulunmayan bir edges anahtarını okumaya çalışır.
Sonraki adımlar
- Sandbox günlük erişimi: kart gerekmeden konumları ve işletme kayıtlarını deneyin. Erişimi siz veya yapay zekâ ajanınız başlatabilir.
- Kimlik doğrulama: API anahtarı üstbilgileri ve anahtar yenileme.
- Hata kodları: HTTP durum kodları ve hata yanıtının yapısı.
- SDK'lar: tür tanımları içeren Python ve Node istemcileri.