GREM API kabinetdə olanlara proqram yolu ilə çıxış verir: alətlər (qiymətləndirmə, mətnlər, video, fotolar, PDF, saytlar), obyektləriniz, lidlər və hadisələr. Bütün sorğular bir ünvana göndərilir:
https://developers.grem.capital/api/v1
Maşın tərəfindən oxunan tam təsvir /openapi.json ünvanındadır, interaktiv təsvir isə /docs ünvanında.
Açar yaradın
Kabinetdə API → Açarlar bölməsini açın və Açar yarat düyməsini basın. Açar yalnız bir dəfə göstərilir - onu sirlər menecerində saxlayın. Yeni açara bütün icazələr verilir; yaradarkən onları məhdudlaşdıra bilərsiniz. Ətraflı: Autentifikasiya.
Açarı yoxlayın
curl https://developers.grem.capital/api/v1/ping \
-H "Authorization: Bearer gsk_live_xxx"
{"ok": true, ...} cavabı açarın işlədiyini göstərir. GET /ping pulsuzdur və heç bir icazə tələb etmir. GET /me açarın dəqiq nələri edə biləcəyini göstərir.
Sinxron aləti çağırın
Ekspress qiymətləndirmə dərhal cavab 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 təkrar sorğunu təhlükəsiz edir: eyni açarla təkrarlanan sorğu ilk nəticəni qaytarır və yenidən ödəniş tutulmur.
Asinxron tapşırığı başladın
Uzun çəkən alətlər 202 və tapşırıqla cavab verir. Nəticəni vebhukla almaq istəyirsinizsə, əvvəlcə abunə olun (5-ci addım): abunəlikdən əvvəl başladılmış tapşırıq öz hadisəsini göndərmir.
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 dəyəri completed, partial və ya failed olana qədər statusu sorğulayın (pulsuzdur):
curl https://developers.grem.capital/api/v1/text/generate/jobs/JOB_ID \
-H "Authorization: Bearer gsk_live_xxx"
Tapşırıqların necə işlədiyi və faylların necə yüklənəcəyi: Tapşırıqlar və nəticələr.
Nəticəni vebhukla alın
Sorğulamaq əvəzinə hadisəyə abunə olun - tapşırıq bitəndə GREM sizin URL-ə POST göndərir. Tapşırığı başlatmazdan əvvəl abunə olun: abunəlikdən əvvəl başladılmış tapşırıq öz hadisəsini göndərmir.
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"]}'
Cavabda imza sirri whsec_... var - o, yalnız bir dəfə göstərilir. İmzanı necə yoxlamaq olar: Vebhuklar.
Pul xərcləmədən sınayın: gsk_test prefiksli açar (yaradarkən Test açar növünü seçin) sandbox mühitində işləyir: alətlər nümunə nəticələrlə cavab verir, heç nə yaradılmır və ödəniş tutulmur.
Növbəti addımlar
- API vasitəsilə alətlər - bütün alətlər və onların nə etdiyi.
- Xətalar - imtinaları necə oxumaq və nəyi təkrarlamaq lazımdır.
- Limitlər və ödəniş - neçə sorğu mümkündür və nəyə görə ödəniş tutulur.
- TypeScript SDK - asılılıqları olmayan hazır klient.