API અને વેબહુક વડે તમારું પોતાનું સૉફ્ટવેર જોડો

તે ટૂલને જોઈતી પરવાનગીઓ જ ધરાવતી કી બનાવો

સેટિંગ્સ → API અને વેબહુક → કી બનાવો. તેને વ્યક્તિના નામે નહીં, ટૂલના નામે નામ આપો — મહિનાઓ પછી આ યાદીમાં અને સુરક્ષા લૉગમાં તમને એ જ નામ દેખાશે. પછી પરવાનગીઓ ટિક કરો, અને ફક્ત જરૂરી જ: જે કી ફક્ત વાંચી શકે છે તેનાથી કંઈ પણ લખાવી શકાતું નથી.

• leads:read — લીડ્સ, તબક્કા અને પરિણામો વાંચો
• leads:write — લીડ્સ બનાવો, અપડેટ કરો અને કાઢી નાખો, નોંધો ઉમેરો
• calls:read — કૉલ ઇતિહાસ વાંચો
• users:read — આ વર્કસ્પેસના લોકોની માહિતી વાંચો
• webhooks:manage — વેબહુક બનાવો અને કાઢી નાખો

હમણાં જ કૉપિ કરો — તે એક જ વાર દેખાય છે

કી lk_live_ થી શરૂ થાય છે અને તે બનાવ્યા પછી તરત આવતા ડાયલૉગમાં ફક્ત એક જ વાર દેખાય છે. તેનો ફક્ત હૅશ સંગ્રહાય છે, તેથી પછીથી કોઈ તેને પાછી વાંચી શકતું નથી; યાદીમાં પહેલા થોડા અક્ષર દેખાય છે જેથી તમે તમારી કી ઓળખી શકો. ખોવાઈ જાય તો ઉપાય એ છે કે તે કી રદ કરો અને નવી બનાવો. કી કોઈ એક એજન્ટની નહીં, વર્કસ્પેસની હોય છે — તમારી લીડ્સનો ફક્ત એક ભાગ જોતું ઇન્ટિગ્રેશન અડધો ડેટા સિંક કરશે અને તૂટેલું લાગશે — અને તે જે કંઈ લખે તે સુરક્ષા લૉગમાં તેના નામે નોંધાય છે.

બેઝ URL અને પહેલો કૉલ

સેટિંગ્સ → API અને વેબહુક તમારું બેઝ URL બતાવે છે — આજે https://api.lumakol.com/api/v1 — અને કી દરેક વિનંતી પર bearer ટોકન તરીકે જાય છે. પહેલો કૉલ GET /ping કરો: તે જવાબમાં કી કયા વર્કસ્પેસની છે અને તેમાં કઈ પરવાનગીઓ છે તે આપે છે, જેથી કોઈ સાચો કોડ લખતાં પહેલાં જ સાબિત થાય કે કી, હેડર અને સરનામું ત્રણેય બરાબર છે. દરેક એન્ડપોઇન્ટ, ફીલ્ડ અને એરર કોડ API સંદર્ભમાં આપેલા છે: સેટિંગ્સ → API અને વેબહુક → API સંદર્ભ (તમારે સાઇન ઇન હોવું જરૂરી છે).

• curl https://api.lumakol.com/api/v1/ping -H "Authorization: Bearer lk_live_…"

તમારી લીડ્સ વાંચો

GET /leads લીડ્સનું એક પેજ અને અપેક્ષિત ફિલ્ટર આપે છે: stage, owner, source, tag, ટેક્સ્ટ શોધ માટે q, અને એક સાથે 200 સુધી limit. જવાબ ખાલી યાદી નહીં પણ ઑબ્જેક્ટ હોય છે — લીડ્સ data માં હોય છે, અને તેની બાજુમાં next_cursor અને has_more હોય છે.

• curl "https://api.lumakol.com/api/v1/leads?limit=100" -H "Authorization: Bearer lk_live_…"
• GET /leads/find ફોન, ઈમેલ અથવા તમે જાતે સેટ કરેલા external_id વડે એક લીડ શોધે છે
• GET /stages અને GET /dispositions તમારી પોતાની પાઇપલાઇન અને પરિણામ યાદીઓ પાછળના id આપે છે

પેજિંગ, અને નકલને અદ્યતન રાખવી

પેજનું next_cursor ને cursor તરીકે પાછું મોકલો અને has_more false થાય ત્યાં સુધી પુનરાવર્તન કરો; cursor સ્થિર છે, તેથી તમે પેજિંગ કરતા હો ત્યારે બદલાતી લીડ્સને કારણે કોઈ પંક્તિ છૂટી જતી નથી. સતત સિંક માટે, છેલ્લે ક્યારે ચલાવ્યું તે યાદ રાખો અને આગલી વખતે તેને updated_since તરીકે મોકલો — તમને ત્યારથી બદલાયેલું જ મળે છે, અને તેમાં પણ એ જ રીતે પેજિંગ કરો. દરેક કી મિનિટમાં 60 વિનંતી કરી શકે છે, અને એક વર્કસ્પેસ તેની બધી કી મળીને મિનિટમાં 120 અને દિવસમાં 10,000. API કી ચૂકવેલ પ્લાનમાં ઉપલબ્ધ છે, મફત ટ્રાયલ દરમિયાન નહીં. જવાબોમાં RateLimit-Limit, RateLimit-Remaining અને RateLimit-Reset હેડર હોય છે, અને 429 સાથે Retry-After આવે છે; Remaining શૂન્ય થાય ત્યારે લૂપમાં ફરી પ્રયાસ કરવાને બદલે reset સુધી રાહ જુઓ.

વેબહુક ઉમેરો

સેટિંગ્સ → API અને વેબહુક → વેબહુક ઉમેરો. URL https હોવું જોઈએ અને ઇન્ટરનેટ પરથી પહોંચી શકાય તેવું હોવું જોઈએ — ખાનગી કે આંતરિક સરનામું સાચવતી વખતે નકારાય છે અને દરેક ડિલિવરી પહેલાં ફરી તપાસાય છે, તેથી પછીથી DNS બદલીને તેમાંથી છટકી શકાતું નથી. તમને જોઈતી ઘટનાઓ ટિક કરો, પછી ટેસ્ટ વાપરીને નમૂનાની ડિલિવરી કતારમાં મૂકો અને તેના પર આધાર રાખતાં પહેલાં ખાતરી કરો કે તમારું રિસીવર કામ કરે છે. ડિલિવરી દર દસ સેકન્ડે તપાસાતી કતારમાંથી મોકલાય છે, તેથી તરત નહીં પણ થોડી સેકન્ડોમાં તેની અપેક્ષા રાખો.

• lead.created — લીડ હાથથી, API દ્વારા, ફોર્મ, લીડ સ્રોત, વેબસાઇટ ચૅટ કે મિસ્ડ કૉલ દ્વારા ઉમેરાય (ફાઇલ આયાતથી નહીં)
• lead.updated — લીડ ઍપમાં, API દ્વારા કે ઑટોમેશન નિયમ દ્વારા એડિટ થાય (કૉલ પરિણામ લૉગ કરવાથી તેના બદલે call.logged મોકલાય છે)
• lead.stage_changed — લીડ પાઇપલાઇનના બીજા તબક્કામાં જાય
• lead.assigned — લીડ કોઈને સોંપાય, અથવા પાછી લેવાય
• call.logged — કોઈ કૉલ સામે પરિણામ લૉગ થાય
• follow_up.due — માલિકવાળી લીડનો ફૉલો-અપ 15 મિનિટમાં બાકી થાય

સહી ચકાસો

દરેક વિનંતીમાં ચાર હેડર હોય છે: X-LumaKol-Event, X-LumaKol-Delivery, X-LumaKol-Timestamp અને X-LumaKol-Signature. સહી એટલે sha256= અને તેના પછી timestamp, એક પૂર્ણવિરામ અને raw body નો HMAC-SHA256, જેની કી વેબહુક બનાવતી વખતે બતાવાયેલું signing secret છે — તે whsec_ થી શરૂ થાય છે. તમે ફરીથી સીરિયલાઇઝ કરેલા JSON પર નહીં, પણ ખરેખર મળેલા bytes પર તેની ફરી ગણતરી કરો, બંનેની તુલના constant-time સરખામણીથી કરો, અને જેનો timestamp તાજો ન હોય તે નકારો. જે વિનંતી મેળ ન ખાય તે અમારી તરફથી આવી નથી.

• સહી થતી સ્ટ્રિંગ છે timestamp, એક પૂર્ણવિરામ, પછી body — આ જ ક્રમમાં
• X-LumaKol-Delivery ફરી પ્રયાસોમાં સ્થિર રહે છે: તેને સંગ્રહો અને પુનરાવર્તનને અવગણો, કારણ કે અમારી બાજુએ ટાઇમઆઉટ થયેલી ડિલિવરીનો ફરી પ્રયાસ થાય છે, ભલે તમારા સર્વરે તે પૂરી કરી હોય
• “નવું સિક્રેટ” કી બદલે છે અને જૂની તરત કામ કરતી બંધ થાય છે, તેથી પહેલાં તમારું રિસીવર અપડેટ કરો

ડિલિવરી લૉગ અને ફરી પ્રયાસો

વેબહુક હેઠળ “તાજેતરની ડિલિવરી” ખોલીને છેલ્લી ડિલિવરી જુઓ: ઘટના, તે પહોંચી કે નહીં, તમારા સર્વરે પરત કરેલો સ્ટેટસ કોડ અથવા અમને આવેલી એરર, અને ક્યારે. 2xx ન હોય તે બધું — રીડાયરેક્ટ પણ નિષ્ફળતા ગણાય છે — પાંચ મિનિટ, પંદર મિનિટ, એક કલાક, ત્રણ કલાક, છ કલાક અને ફરી છ કલાક પછી ફરી પ્રયાસ થાય છે: લગભગ સોળ કલાકમાં સાત પ્રયાસ, તેથી થોડા સમય માટે બંધ રહેલું રિસીવર કંઈ ગુમાવતું નથી અને આખો દિવસ બંધ રહેલા રિસીવર માટે આખરે પ્રયાસ છોડી દેવાય છે. ફક્ત સ્ટેટસ કોડ કે એરર રાખવામાં આવે છે, તમારા જવાબનું body નહીં. વેબહુક સફળ ન થાય અથવા તમે તેને બંધ કરીને ફરી ચાલુ ન કરો ત્યાં સુધી તેની છેલ્લી નિષ્ફળતા દેખાતી રહે છે.

• સ્વિચ વેબહુકને કાઢી નાખ્યા વિના થોભાવે છે — રીડિપ્લૉય કરતી વખતે તમને આ જ જોઈએ
• ડિલિવરી પંક્તિઓ ડીબગિંગ માટેની મદદ છે, રેકૉર્ડ નથી — લગભગ બે અઠવાડિયા પછી તે સાફ થઈ જાય છે
• વેબહુક કાઢી નાખવાથી તેના માટે કતારમાં બાકી રહેલું બધું રદ થાય છે

કામ પૂરું થાય ત્યારે કી રદ કરો

રદ કરો તે કી વાપરતી દરેક વસ્તુ તરત જ બંધ કરે છે, અને તે પાછું વાળી શકાતું નથી — થોભાવવાનો વિકલ્પ જાણીજોઈને રાખ્યો નથી. ટૂલ બંધ થાય, તેને સેટ કરનાર વ્યક્તિ છોડી જાય, અથવા કી લીક થઈ હોવાની શંકા થાય કે તરત રદ કરો, પછી નવી કી બનાવો અને ટૂલમાં પેસ્ટ કરો. યાદીમાં દરેક કી છેલ્લે ક્યારે વપરાઈ તે દેખાય છે — હવે કોઈને ન જોઈતી કી ઓળખવાનો આ સૌથી ઝડપી રસ્તો છે.