Obyekt cavablarında kateqoriya və atribut sahələri kodlar şəklində gəlir (məsələn, type: "Residential", condition: "Cosmetic renovation", utilitySystem: ["gas", "water"]). Bu endpoint kodları dəstəklənən 10 dildən istənilən birində insan üçün oxunaqlı adlara çevirir. Pulsuzdur və istənilən açar üçün açıqdır.
Baza URL: https://developers.grem.capital/api/v1.
Bir dil üçün adlar
GET /dictionaries?lang=en
Authorization: Bearer gsk_live_...
Həmin dil üçün bütün lüğətləri düz { code: label } şəklində qaytarır:
{
"version": "sha256-...",
"lang": "en",
"dictionaries": {
"propertyType": { "Residential": "Residential", "Commercial": "Commercial", ... },
"condition": { ... },
"utilitySystem": { ... },
...
},
"requestId": "req_..."
}
Dəstəklənən lang dəyərləri: en, ru, uk, de, es, az, ar, fr, zh, tr. Qalan hər şey - 400. Kodun tələb olunan dildə adı olmadıqda ingiliscə adı qaytarılır.
Variantlar
- Bütün dillər birdən -
langparametrini göndərməyin. Hər kodlabelsobyekti ilə gəlir:{ "value": "Residential", "labels": { "en": "Residential", "uk": "Житлова", ... } }. - Bir lüğət -
nameəlavə edin, məsələn,GET /dictionaries?name=propertyType&lang=en. Naməlum ad -404.
Mövcud lüğətlər
propertyType, residentialType, commercialType, industrialType, condition, utilitySystem, amenities, onsiteAmenities, apartType, apartmentType, status, objectType.
Cavabda version var və o, bir gün keşlənir - bir dəfə alın və təkrar istifadə edin. Zaman keçdikcə yeni kodlar əlavə oluna bilər, ona görə kod keşlənmiş nüsxənizdə yoxdursa, xəta verməyin, xam kodu göstərin.