GREM API, panelin sunduklarına programla erişim sağlar: araçlar (değerleme, metinler, video, fotoğraflar, PDF'ler, siteler), ilanlarınız, lead'leriniz ve olaylar. Tüm istekler tek bir adrese gider:
https://developers.grem.capital/api/v1
Makine tarafından okunabilir tam açıklama /openapi.json adresindedir; etkileşimli sürüm /docs adresindedir.
Bir anahtar oluşturun
Panelde API → Anahtarlar bölümünü açın ve Anahtar oluştur düğmesine tıklayın. Anahtar yalnızca bir kez gösterilir: bir gizli bilgi yöneticisinde saklayın. Yeni anahtar tüm kapsamları alır; oluştururken bunları daraltabilirsiniz. Ayrıntılar: Kimlik doğrulama.
Anahtarı kontrol edin
curl https://developers.grem.capital/api/v1/ping \
-H "Authorization: Bearer gsk_live_xxx"
{"ok": true, ...} anahtarın çalıştığı anlamına gelir. GET /ping ücretsizdir ve kapsam gerektirmez. GET /me anahtarın tam olarak neler yapabildiğini gösterir.
Eşzamanlı bir aracı çağırın
Hızlı değerleme hemen yanıt verir:
curl -X POST https://developers.grem.capital/api/v1/valuation/express \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 6b1f0c2e-6c1e-4a8e-9f5d-3c2a1b0e9d87" \
-d '{"propertyCategory":"apartment","addressText":"Torstraße 12, Berlin","totalArea":64,"rooms":2,"currency":"EUR"}'
{
"estimate": { "pricePoint": <number>, "rangeLow": <number>, "rangeHigh": <number>, "confidence": "<level>", "currency": "EUR" },
"requestId": "req_..."
}
Idempotency-Key tekrarı güvenli kılar: isteği aynı anahtarla tekrarlamak ilk sonucu döndürür ve yeniden ücret almaz.
Eşzamansız bir iş başlatın
Uzun süren araçlar bir işle 202 yanıtı verir. Sonucu webhook ile almak istiyorsanız önce abone olun (5. adım): abonelikten önce başlatılan bir iş kendi olayını göndermez.
curl -X POST https://developers.grem.capital/api/v1/text/generate \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{"city":"Berlin","totalArea":64,"rooms":2,"propertyCategory":"apartment","language":"en"}'
{ "jobId": "...", "status": "...", "state": "pending", "requestId": "req_..." }
state değeri completed, partial veya failed olana kadar durumu sorgulayın (ücretsiz):
curl https://developers.grem.capital/api/v1/text/generate/jobs/JOB_ID \
-H "Authorization: Bearer gsk_live_xxx"
İşlerin nasıl çalıştığı ve dosyaların nasıl indirileceği: İşler ve sonuçlar.
Sonucu webhook ile alın
Sorgulamak yerine olaya abone olun: iş bittiğinde GREM, URL'nize bir POST gönderir. İşi başlatmadan önce abone olun: abonelikten önce başlatılan bir iş kendi olayını göndermez.
curl -X POST https://developers.grem.capital/api/v1/webhooks \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/grem-hook","events":["text.completed","text.failed"]}'
Yanıt, imzalama gizli anahtarı whsec_... içerir; yalnızca bir kez gösterilir. İmzanın nasıl doğrulanacağı: Webhook'lar.
Harcama yapmadan test edin: gsk_test önekli bir anahtar (oluştururken anahtar türü olarak Test seçin) sandbox içinde çalışır: araçlar örnek sonuçlarla yanıt verir, hiçbir şey oluşturulmaz veya ücretlendirilmez.
Sonraki adımlar
- API üzerinden araçlar: tüm araçlar ve ne yaptıkları.
- Hatalar: retler nasıl okunur ve neler tekrarlanır.
- Limitler ve ücretlendirme: kaç istek ve neyin ücretli olduğu.
- TypeScript SDK: bağımlılığı olmayan hazır bir istemci.