تمنح واجهة GREM البرمجية وصولا برمجيا إلى ما توفره لوحة التحكم: الأدوات (التقييم، والنصوص، والفيديو، والصور، وملفات PDF، والمواقع)، وعقاراتك، وعملاءك المحتملين، والأحداث. تذهب كل الطلبات إلى عنوان واحد:
https://developers.grem.capital/api/v1
الوصف الكامل المقروء آليا موجود في /openapi.json، والنسخة التفاعلية في /docs.
أنشئ مفتاحا
في لوحة التحكم افتح API → المفاتيح واضغط إنشاء مفتاح. يُعرض المفتاح مرة واحدة فقط، فاحفظه في مدير أسرار. يحصل المفتاح الجديد على كل النطاقات، ويمكنك تضييقها عند الإنشاء. التفاصيل: المصادقة.
افحص المفتاح
curl https://developers.grem.capital/api/v1/ping \
-H "Authorization: Bearer gsk_live_xxx"
{"ok": true, ...} تعني أن المفتاح يعمل. GET /ping مجاني ولا يحتاج إلى نطاق. GET /me يبين ما يستطيع المفتاح فعله بالضبط.
استدع أداة متزامنة
التقييم السريع يجيب فورا:
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 يجعل الإعادة آمنة: تكرار الطلب بالمفتاح نفسه يعيد النتيجة الأولى ولا يخصم مرة أخرى.
ابدأ مهمة غير متزامنة
الأدوات الطويلة تجيب بالرمز 202 مع مهمة. إذا أردت النتيجة عبر webhook فاشترك أولا (الخطوة 5): المهمة التي بدأت قبل الاشتراك لا ترسل حدثها.
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 هي completed أو partial أو failed:
curl https://developers.grem.capital/api/v1/text/generate/jobs/JOB_ID \
-H "Authorization: Bearer gsk_live_xxx"
كيف تعمل المهام وكيف تُنزَّل الملفات: المهام والنتائج.
استلم النتيجة عبر webhook
بدلا من الاستعلام، اشترك في الحدث: يرسل GREM طلب POST إلى عنوانك عند انتهاء المهمة. اشترك قبل بدء المهمة: المهمة التي بدأت قبل الاشتراك لا ترسل حدثها.
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"]}'
يحتوي الرد على سر التوقيع whsec_... ويُعرض مرة واحدة. كيفية التحقق من التوقيع: Webhooks.
اختبر دون إنفاق: المفتاح ذو البادئة gsk_test (اختر نوع المفتاح تجريبي عند إنشائه) يعمل في بيئة الاختبار: تجيب الأدوات بنتائج نموذجية، ولا يُنشأ أو يُخصم شيء.
الخطوات التالية
- الأدوات عبر API: كل الأدوات وما تفعله.
- الأخطاء: كيف تقرأ حالات الرفض وما الذي تعيده.
- الحدود والفوترة: عدد الطلبات وما الذي يُحتسب.
- TypeScript SDK: عميل جاهز بلا تبعيات.