Scratcher REST API, kendi sistemlerinizin kampanyalarınızı, lead'lerinizi ve listelerinizi okumasını, lead eklemesini ve güncellemesini, ürünleri ve yerleşimleri yönetmesini sağlar. Bu makale, kurulumu yapan geliştirici için hazırlanmıştır.
API, Webhooks & API içeren planlara (Basic ve üzeri) dahildir. Diğer planlarda belirteç ve uygulama oluşturma düğmeleri kilitlidir.
Kişisel erişim belirteci oluşturun
Kişisel erişim belirteci, API'yi kendi betiklerinizden ve sistemlerinizden çağırmanın en hızlı yoludur.
- Settings > API bölümüne gidin (Developers altında).
- Personal access tokens altında Create personal access token öğesine tıklayın. İletişim kutusunda "Generate a token to authenticate API requests." yazar.
- Belirtece daha sonra tanıyacağınız bir Name verin; örneğin "Veri ambarı".
- Scopes altında belirtecin neler yapabileceğini seçin (aşağıya bakın). Select all tüm kapsamları seçer. Belirtece yalnızca ihtiyaç duyduğu erişimi verin.
- Save düğmesine tıklayın. "Your access token has been created" mesajını görürsünüz.
- Secret altındaki belirteci kopyalayın. "Save the secret above, as this is the only time you will see it." Belirteci güvenli bir yerde, örneğin bir parola yöneticisinde saklayın.
- Close düğmesine tıklayın.
Belirteç kullanıcınıza aittir. Seçtiğiniz kapsamlarla, üyesi olduğunuz tüm Scratcher hesaplarına erişebilir.
Kapsamlar
read:campaigns(View campaigns): kampanyaları listeleme ve okumaread:lists(View lists): lead listelerini listeleme ve okumaread:leads(View leads): lead'leri okumawrite:leads(Write leads): bir listedeki lead'leri oluşturma, güncelleme ve silmeread:placements(View placements): yerleşimleri okumawrite:placements(Write placements): yerleşimleri oluşturma, güncelleme ve silmeread:products(View products): ürünleri okumawrite:products(Write products): ürünleri oluşturma, güncelleme ve silme
Bir kampanyanın lead'lerini okumak için belirtecin hem read:campaigns hem de read:leads kapsamına sahip olması gerekir. Yerleşim oluşturmak ve değiştirmek için ayrıca planınızda Embed / URL bulunmalıdır.
Belirteci iptal edin
Show personal access token ekranını açmak için listedeki belirtece tıklayın. Burada Name ve Scopes görüntülenir. Revoke düğmesine tıklayıp onaylayın ("Are you sure you want to delete this token? This cannot be undone!"). Belirteci kullanan her şey anında çalışmayı durdurur.
İstek gönderin
Temel URL https://platform.scratcher.io/api/v1/ adresidir. Belirteci Authorization başlığında gönderin ve JSON isteyin:
curl https://platform.scratcher.io/api/v1/accounts \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Accept: application/json" Temel uç noktalar
GET /me: belirtecin ait olduğu kullanıcıGET /accounts: erişiminiz olan hesaplar. Diğer çağrılarda hesap kimliğini kullanın.GET /accounts/{account}/campaignsve/campaigns/{campaign}: kampanyalarınızGET /accounts/{account}/campaigns/{campaign}/leads: bir kampanyanın lead'leri; en yeniden eskiye, alanları, kabul edilen onaylar ve kazananlar için ödül ile kodla birlikteGET /accounts/{account}/listsve/lists/{list}: lead listeleriniz/accounts/{account}/lists/{list}/leads: bir listenin lead'leri. Okumak içinGET, oluşturmak içinPOST, güncellemek içinPUT, silmek içinDELETE. Bir lead'inemail,phone_numberve isteğe bağlıcustom_tokenalanları vardır./accounts/{account}/products: ürünler (GET,POST,PUT,DELETE)/accounts/{account}/placements: yerleşimler (GET,POST,PUT,DELETE)
Listeler sayfalara bölünmüştür: ?page=2 vb. ekleyin. Yalnızca üyesi olduğunuz hesaplara erişebilirsiniz; diğer hesap kimlikleri hata döndürür.
Sınırlar
Kullanıcı başına dakikada 60 istek gönderebilirsiniz. Sınırı aşarsanız API 429 durum koduyla yanıt verir; kısa bir süre bekleyip tekrar deneyin.
API başvurusu
Tüm alanları, filtreleri, örnekleri ve bir Postman koleksiyonunu içeren eksiksiz başvuru kaynağı API başvuru belgelerinde yer alır. Settings > API sayfasının üst kısmındaki API reference düğmesi de bu belgelere bağlantı verir.
OAuth ile uygulama geliştirin
Diğer Scratcher kullanıcılarının kendi hesaplarına bağladığı bir uygulama geliştiriyorsanız kişisel belirteç yerine bir OAuth uygulaması kaydedin.
- Settings > API bölümüne gidin. My apps altında Create app öğesine tıklayın ("Register an OAuth application for the API.").
- Application name (kullanıcılar uygulamanızı onaylarken bu adı görür) ve Redirect URI (kullanıcıların onaydan sonra geri yönlendirileceği adres) alanlarını doldurun.
- Save düğmesine tıklayın. Client ID ve Client secret ile birlikte "Your app has been created!" mesajını görürsünüz.
- İstemci gizli anahtarını hemen kopyalayın: "Save the client secret above, as this is the only time you will see it." Continue düğmesine tıklayın.
Uygulamanız kullanıcıları istemci kimliğiniz, yönlendirme URI'niz ve ihtiyaç duyduğu kapsamlarla https://platform.scratcher.io/oauth/authorize adresine yönlendirir. Kullanıcı Scratcher'a giriş yapar ve bir Authorization request görür: "This application will be able to:" ifadesinin ardından kapsamlar listelenir. Kullanıcı Authorize veya Cancel düğmesine tıklar. Ardından uygulamanız kodu https://platform.scratcher.io/oauth/token adresinde belirteçlerle değiştirir.
- OAuth erişim belirteçleri iki ay geçerlidir. Yenileme belirteçleri üç ay geçerlidir; yeni bir erişim belirteci almak için bunları kullanın.
- Adı veya yönlendirme URI'sini değiştirmek için My apps altındaki uygulamaya tıklayın, değişikliği yapın ve Save düğmesine tıklayın ("Your settings have been saved"). "You cannot view your secret afterwards."
- Delete app uygulamayı kaldırır ve tüm kullanıcıların uygulamayla bağlantısı çalışmayı durdurur: "Are you sure you want to delete this app? This cannot be undone!"
Onayladığınız uygulamalar
Authorized apps, hesabınıza erişim verdiğiniz uygulamaları (örneğin Zapier) sahip oldukları kapsamlarla birlikte listeler. Erişimi geri almak için Revoke düğmesine tıklayın.
API'yi kimler kullanabilir?
API sayfası Owner, Admin veya Manager rolüne sahip kullanıcılara gösterilir. Bir belirteç, onu oluşturan kullanıcının yapabileceğinden fazlasını asla yapamaz.