Obyektin landing səhifəsi
POST /site/create - tools:sitegen icazəsi, dərhal. Obyekt üçün paylaşıla bilən linki olan landing səhifə - sizin obyektiniz və ya istənilən ictimai obyekt üçün. Təsvirin tərcüməsi və saytın qurulması bəzən ~100 saniyədən uzun çəkir, bundan sonra cavab 524 ilə kəsilir: Prefer: respond-async başlığı və Idempotency-Key ilə dərhal sorğu tapşırığı ilə 202 gəlir; GET /site/create/jobs/{id} ünvanını sorğulayın (pulsuz) - result eyni 200 cavabını saxlayır. Hadisələr - site.completed / site.failed.
| Sahə | Növ | Təsvir |
|---|---|---|
objectId | string | məcburi: obyektin identifikatoru |
siteName | string | siyahınızda linkin adı |
language | string | ENG (standart), RUS, UKR, DEU, SPA, AZE, ARB, FRA, ZHO, TUR |
coverPhotoId | string | ilk göstəriləcək obyekt fotosu |
brandColor | string | vurğu rəngi #RRGGBB |
showPhone | bəli/xeyr | telefonunuzu səhifədə göstərmək (standart - xeyr) |
curl -X POST https://developers.grem.capital/api/v1/site/create \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{"objectId":"OBJECT_ID","siteName":"Torstraße 12","language":"ENG"}'
Cavab:
| Sahə | Təsvir |
|---|---|
landingId | saytın identifikatoru |
baseUrl | saytın ünvanı |
link | yaradılmış link: ad, dil, kod və ünvan |
objectId yoxdursa - 400; obyekt əlçatan deyilsə - 403 və ya 404.
PDF təqdimatı
POST /pdf/create - tools:pdf icazəsi, tapşırıq. Obyekt üçün brendli PDF - sizin obyektiniz və ya istənilən ictimai obyekt üçün.
| Sahə | Növ | Təsvir |
|---|---|---|
pdfName | string | məcburi: sənədin adı, 200 simvola qədər |
objectId | string | məcburi: obyektin identifikatoru |
language | string | ENG (standart), RUS, UKR, DEU, SPA, AZE, ARB, FRA, ZHO, TUR |
descriptionType | string | presentation (standart), description və ya social |
currency | string | UAH, USD, EUR, AZN, GBP, AED, CNY, TRY, GEL |
priceForPdf | number | sənəd üçün fərqli qiymət |
coverPhotoId | string | üz qabığı fotosu |
descriptionOverride | string | yalnız bu sənəd üçün öz mətniniz, 3000 simvola qədər |
brandColor | string | vurğu rəngi #RRGGBB |
curl -X POST https://developers.grem.capital/api/v1/pdf/create \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{"pdfName":"Torstraße 12 - presentation","objectId":"OBJECT_ID","language":"ENG"}'
Dil bu siyahıdan böyük hərflərlə göstərilməlidir: ru və ya en 400 qaytarır.
jobId ilə 202. Bitmiş tapşırıq (GET /pdf/create/jobs/{id}):
| Sahə | Təsvir |
|---|---|
link | sənədin birbaşa ünvanı |
pageCount | səhifələr |
sizeBytes | ölçü |
coverImageUrl | üz qabığı |
Fayl həmçinin GET /artifacts/v1/ai/pdf-generator/files/{id}/download ünvanında əlçatandır. Hadisələr - pdf.completed / pdf.failed.
Şəxsi flayer
POST /flyer/create - tools:flyer icazəsi, dərhal. Fotonuz, platformanın göstəriciləri və referal linkinizə aparan QR kodu olan broker flayeri (A4, kvadrat və ya story). Flayerin özü pulsuzdur; yalnız API çağırışı üçün ödəniş tutulur.
| Sahə | Növ | Təsvir |
|---|---|---|
language | string | ENG (standart) və landing səhifədəki kimi digər kodlar; böyük-kiçik hərf fərqi yoxdur |
layouts | array | a4 (çap), feed45, square, story, link; standart ["a4"]; ən azı biri; böyük-kiçik hərf fərqi yoxdur |
formats | array | png, jpg, pdf; standart ["png","pdf"]. PDF yalnız a4 üçün hazırlanır; birdən üçə qədər; böyük-kiçik hərf fərqi yoxdur |
name, role, city, kicker | string | ad, rol, şəhər, alt başlıq |
photoRef | string | avatar - profil fotonuz, və ya data:image/... formatında şəkil |
ctaUrl | string | QR üçün referal link (yalnız platforma domenləri) |
slogan | array | 2 sətrə qədər |
features | array | 6 elementə qədər { "icon", "title" }; icon - crm, ai, globe, publisher, marketing, shield, wallet, chart, lock və ya handshake |
joinTitle, joinNote | string | qoşulmağa çağırış |
builtFor | array | kimin üçün olduğu, 6 sətrə qədər |
footer | array | 2 sətrə qədər |
contacts | object | əlaqə məlumatları: telefon, e-poçt və s. |
Naməlum sahələr nəzərə alınmır.
curl -X POST https://developers.grem.capital/api/v1/flyer/create \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{"language":"ENG","layouts":["a4"],"formats":["pdf"],"name":"Anna Schmidt","role":"Real estate agent","city":"Berlin","photoRef":"avatar"}'
Cavab:
| Sahə | Təsvir |
|---|---|
files | yaradılmış fayllar |
files[].layout, files[].format | maket və fayl növü |
files[].width, files[].height, files[].bytes | ölçü |
files[].path | yükləmə yolu: https://developers.grem.capital/api/v1/artifacts + path |
ctaUrl | QR-da çap olunan link |
historyId | flayer tarixçəsindəki qeyd |
Sənədlərdən və ya saytdan qaralama
POST /draft/extract - tools:draft icazəsi, dərhal. GREM broşürləri, qiymət siyahılarını və ya tikinti şirkətinin saytını oxuyur və sahələri və fotoları olan obyekt qaralaması yaradır. Limit: hesab üzrə gündə 2 qaralama; növbəti qaralama ertəsi günə qədər 403 ilə rədd edilir. Yalnız API çağırışı üçün ödəniş tutulur, alətin qiyməti yoxdur. Böyük sənəd ~100 saniyədən uzun oxuna bilər, bundan sonra cavab 524 ilə kəsilir: Prefer: respond-async başlığı və Idempotency-Key ilə fayllar yüklənir və dərhal sorğu tapşırığı (areq_…) ilə 202 gəlir; GET /draft/extract/jobs/{id} ünvanını sorğulayın (pulsuz) - result eyni 200 cavabını saxlayır. Hadisələr - draft.completed / draft.failed.
Gövdə - multipart/form-data:
| Hissə | Təsvir |
|---|---|
data | JSON sətri: {"type": "property"} və ya {"type": "complex"}, istəyə görə "site": "https://..." ilə - məcburi |
| fayllar | istənilən hissə adları altında sənədlər (PDF, DOC/DOCX, şəkillər) |
Ya fayllar, ya da data daxilində site göndərin, əks halda files sahəsi ilə 400 qaytarılır.
curl -X POST https://developers.grem.capital/api/v1/draft/extract \
-H "Authorization: Bearer gsk_live_xxx" \
-F 'data={"type":"complex"}' \
-F "brochure=@brochure.pdf" -F "prices=@pricelist.pdf"
Cavab yaradılmış qaralamadır (dərc olunmayıb). Onu GET /objects/{kind}/{id} və PUT /objects/{kind}/{id} ilə yoxlayın və tamamlayın (Obyektlər).