Swipe Match müştəri üçün broker tapır və lidi növbə ilə brokerlərə təklif edir. API vasitəsilə partnyor broker (və ya agentlik) ona təklif edilmiş və təyin edilmiş lidləri görür və müştəri ilə atdığı addımlar barədə məlumat verir. Oxumaq üçün leads:read scope-u, hadisələr üçün leads:write lazımdır. Ödənişsizdir.
Lidlər
curl "https://developers.grem.capital/api/v1/match/leads?view=active&limit=20" \
-H "Authorization: Bearer gsk_live_xxx"
GET /match/leads:
| Parametr | Təsvir |
|---|---|
view | active (standart) - sizə təyin edilmiş lidlər; inbox - sizə açıq təkliflər. Agentlik açarı agentliyin agentlərinin lidlərini və təkliflərini görür |
stage | mərhələ üzrə filtr |
page, limit | səhifə; limit 50-yə qədər, standart 20; limit və ya page 1-dən kiçik, limit 50-dən çox və ya page 1000-dən çox olduqda - 400 |
GET /match/leads/{id} - bir lid, GET /match/leads/{id}/events - onun tarixçəsi (sizin hadisələriniz və təklifləriniz; pul və xidməti hadisələr, həmçinin müştəri qiymətləndirmələri olmadan). Başqasının lidi - 404.
Swipe Match hesabınızda API girişi üçün açılana qədər bu sorğular 409 və code: not_available ilə cavab verir.
Lidin sahələri:
| Sahə | Təsvir |
|---|---|
id, stage | id və mərhələ |
clientType | buyer və ya seller |
country, objectId, objectIds | ölkə və sorğunun aid olduğu elanlar |
budget | min, max, currency |
answers | müştərinin cavabları: budget, timeline, payment |
qualScore, qualBand | lidin keyfiyyət balı |
clientInitial | müştəri adının ilk hərfi |
offer | sizə açıq təklif: id, wave, offeredAt, deadline |
contactDeadline, meetingDeadline | hansı tarixə qədər əlaqə saxlamaq və görüşmək lazımdır |
deal, reservation, dealObjects | sövdələşmə və rezerv məlumatları |
client | müştərinin name və phone sahələri - yalnız lid sizə təyin edildikdən və kontakt açıldıqdan sonra |
brokerId | görünüşü göstərilən broker |
fee | bu lid üzrə platformanın sizdən aldığı haqq: none, percent (aldığınız komissiyanın həmin faizi, percent sahəsində) və ya contract (razılaşma ilə); məbləğlər heç vaxt göstərilmir |
Mərhələlər (stage): new, offered, intro, match, contact, meeting_scheduled, meeting_held, contract, deal, closed, lost.
Lid üzrə addımlarınız
POST /match/leads/{id}/events - yalnız sizə təyin edilmiş lid üçün. Modul addımın cari mərhələdə icazəli olub-olmadığını yoxlayır.
event | Sahələr | Mənası |
|---|---|---|
FIRST_CONTACT | channel: phone (standart) və ya messenger | müştəri ilə əlaqə saxladınız |
RESERVATION | amount, currency (3 hərf), date; documentFileId - istəyə bağlı | müştəri rezerv ödədi |
STAGE_ROLLBACK | reasonCode: client_withdrew, seller_withdrew, financing_failed, documents, other; text - 500 simvola qədər | lidi bir mərhələ geri qaytarmaq |
LEAD_LOST | reasonCode: client_refused, client_unreachable, bought_elsewhere, not_target, other; text. Başqa səbəb - 400 | lid itirildi |
DEAL_CLOSED | objectId, amount, currency, date, documentFileId; commissionReceived, commissionCurrency - istəyə bağlı | sövdələşmə bağlandı |
documentFileId - POST /uploads ilə yüklənmiş faylın id-si (Fayllar). Siyahıdan kənar reasonCode - 400; LEAD_LOST üçün other ilə text mütləqdir (onsuz 400); STAGE_ROLLBACK üçün text yalnız other ilə saxlanılır.
curl -X POST https://developers.grem.capital/api/v1/match/leads/LEAD_ID/events \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: fc-LEAD_ID-1" \
-d '{"event":"FIRST_CONTACT","channel":"phone"}'
Cavab: lead - keçiddən sonrakı lid, replay: true - eyni Idempotency-Key ilə təkrar sorğu olduqda. Müştəri addımları API vasitəsilə göndərilmir. Burada Idempotency-Key 8-128 simvoldan ibarətdir: hərflər, rəqəmlər, _ . : -; başqa format - 400 validation.
İmtinalar 409 və title: business_rule ilə gəlir, səbəb isə code sahəsindədir:
| Səbəb | code |
|---|---|
| addım cari mərhələdə mümkün deyil | invalid_transition |
| müştəri hadisəsidir, brokerlər onu göndərmir | client_event_rejected |
| modul hələ API üçün açılmayıb | not_available |
Hadisələr
match.lead.offered, match.lead.offer_closed, match.lead.matched, match.lead.updated, match.lead.unassigned - bax: Vebhuklar. Hadisələrdə müştərinin kontaktları heç vaxt olmur.