વિકાસકર્તા એકીકરણ

7stamp REST API

ઉપલબ્ધ

7stamp Integration API CRM, ઈકોમર્સ પ્લેટફોર્મ, POS, કસ્ટમ બેકએન્ડ અથવા ઓટોમેશન ટૂલ તમારી પોતાની સિસ્ટમ પહેલાથી જ ઉપયોગ કરે છે તે સંપર્ક ઓળખકર્તા સાથે વૉલેટ લોયલ્ટી કાર્ડનું સંચાલન કરવા દે છે. જ્યારે વિશિષ્ટ એકીકરણ અસ્તિત્વમાં ન હોય ત્યારે તે સાર્વત્રિક વિકલ્પ છે.

API આધાર URL છે https://api.7loc.com/cards-api. દરેક વિનંતીને Bearer ટોકન તરીકે API કી વડે પ્રમાણિત કરો. પ્રોડક્શન લોજિક બનાવતા પહેલા લાઇવ રિક્વેસ્ટ અને રિસ્પોન્સ સ્કીમા માટે લિંક કરેલ OpenAPI સંદર્ભનો ઉપયોગ કરો.

તમે API

સાથે શું કરી શકો છો API એકીકરણ સ્ટેકની લખવાની બાજુ છે. જ્યારે 7stamp વૉલેટ લોયલ્ટી લેયરને હેન્ડલ કરે છે ત્યારે જ્યારે પણ તમારું પોતાનું સોફ્ટવેર સત્યનો કાર્યકારી સ્ત્રોત રહે ત્યારે તેનો ઉપયોગ કરો.

તમારા પોતાના સોફ્ટવેરમાંથી કાર્ડ ઈશ્યૂ કરો

તમારી સિસ્ટમમાં કોઈપણ ગ્રાહક માટે વ્યક્તિગત વૉલેટ કાર્ડ લિંક જનરેટ કરો. તેને તમારા પોતાના ઇમેઇલ, SMS, પુશ અથવા ઇન-એપ ફ્લો દ્વારા વિતરિત કરો. ગ્રાહક લિંક ખોલે છે અને કાર્ડને Apple Wallet અથવા Google Wallet પર સાચવે છે.

કોઈપણ સ્ત્રોતમાંથી ક્રેડિટ સ્ટેમ્પ્સ

જ્યારે તમારા કસ્ટમ POS માં ખરીદી બંધ થાય, જ્યારે તમારી વેબસાઇટ પર ઓનલાઈન ઓર્ડર ચૂકવવામાં આવે અથવા જ્યારે તમારી બુકિંગ સિસ્ટમમાં કોઈ સેવા પૂર્ણ થઈ જાય, ત્યારે ક્રેડિટ સ્ટેમ્પ માટે API પર કૉલ કરો. કાર્ડ સેકન્ડોમાં અપડેટ થાય છે.

વાઉચર્સ અને ઝુંબેશોનું સંચાલન કરો

ચોક્કસ ગ્રાહકને એક જ વારનું વાઉચર જારી કરો, ઝુંબેશ માટે તૈયાર પુરસ્કાર પ્રવાહ બનાવો અને વાઉચરની સ્થિતિને ફાઇનાન્સ અને સેવાની ગુણવત્તા સંભાળતી સિસ્ટમમાં પાછા ખેંચો.

દસ્તાવેજીકૃત એકીકરણ API ઓપરેશન્સ

આ Make અને Zapier ક્રિયાઓ પાછળના સાર્વજનિક API રૂટ છે. API સંદર્ભમાં ચોક્કસ સ્કીમા વાંચો; અલગ એન્ડપોઇન્ટ પરથી ફીલ્ડના નામોનું અનુમાન ન કરો.

કાર્ડ્સ POST /cards/invite

કાર્ડ આમંત્રણ બનાવો

બાહ્ય સંપર્ક માટે એક નવું વ્યક્તિગત ઇન્સ્ટોલ URL બનાવે છે.

કાર્ડ્સ POST /cards/invite/bulk

બલ્ક બનાવો કાર્ડ આમંત્રણો

નિયંત્રિત બેચમાં 100 આમંત્રણ લિંક્સ બનાવે છે.

કાર્ડ્સ GET /cards

કાર્ડ શોધો

બાહ્ય સંપર્ક ઓળખકર્તા દ્વારા કાર્ડ રેકોર્ડ્સ જુએ છે.

કાર્ડ્સ GET /cards/{user_card_id}

કાર્ડની વિગતો મેળવો

એક કાર્ડની સંપૂર્ણ સ્થિતિ તેના આંતરિક 7stamp ID દ્વારા પરત કરે છે.

કાર્ડ્સ POST /cards/scan

કાર્ડ સ્કેન કરો

કાર્ડ ID અથવા External ID દ્વારા સ્ટેમ્પ ઉમેરે છે અને જ્યારે સપ્લાય કરવામાં આવે ત્યારે સ્રોત ઓર્ડર રેકોર્ડ કરે છે.

નમૂનાઓ GET /templates

સૂચિ નમૂનાઓ

કીના કાર્યસ્થળ પર ઉપલબ્ધ કાર્ડ નમૂનાઓની સૂચિ બનાવો/profile.

નમૂનાઓ GET /templates/{template_id}/design

નમૂના ડિઝાઇન મેળવો

જાણીતા કાર્ડ નમૂના માટે વિઝ્યુઅલ સેટિંગ્સ વાંચે છે.

વાઉચર POST /vouchers/issue

વાઉચર જારી કરો

કાર્ડ માલિકને વાઉચર જારી કરે છે.

સંદેશાઓ POST /messages/send

સંદેશ મોકલો

કાર્ડ માલિકને વૉલેટ-કાર્ડ પુશ અને /or ઇમેઇલ સામગ્રી મોકલે છે.

API કી

ક્યાં બનાવવી અને નકલ કરવી આ વાસ્તવિક 7stamp Admin સ્ક્રીન છે. API અને એકીકરણ ખોલો, એક કી ઉમેરો, પછી તેને સુરક્ષિત સર્વર-સાઇડ સિક્રેટ અથવા ઓટોમેશન કનેક્શનમાં કૉપિ કરો.

7stamp Admin API અને એકીકરણ સ્ક્રીન Add API Key બટન દર્શાવે છે અને API કી સંવાદ જનરેટ કરે છે
પગલું 1 — ⟦93g માં &93g માં ખોલો, &93g માં &93g. API Keys, Add API Key પસંદ કરો, યોગ્ય સ્ટાફ લોગિન પસંદ કરો અને કી જનરેટ કરો.
7stamp Admin સંવાદ જે નવી જનરેટ કરેલ API કી અને તેનું કોપી નિયંત્રણ દર્શાવે છે
પગલું 2 — નવી કીને પાસવર્ડ મેનેજર, સર્વર-સાઇડ સિક્રેટ અથવા સુરક્ષિત Make/Zapier કનેક્શનમાં કૉપિ કરો. તેને સોર્સ કોડ, બ્રાઉઝર એપ્લિકેશન અથવા સપોર્ટ ટિકિટમાં પેસ્ટ કરશો નહીં.

કોડિંગ કરતા પહેલા ત્રણ નિર્ણયો લેવાના છે

API કી સ્કોપ

API Integrations → API KeysAdd API Key હેઠળ 7stamp Admin માં કી બનાવો. કી એક કાર્યસ્થળની છે/profile, તેથી જ્યારે તમારું એકાઉન્ટ સેટઅપ તેને મંજૂરી આપે ત્યારે વિકાસ અને ઉત્પાદન માટે અલગ કી બનાવો. જો કોઈ રહસ્ય ખુલ્લું થાય તો ડેશબોર્ડથી ઍક્સેસને ફેરવો અથવા રદબાતલ કરો.

ગ્રાહકની ઓળખ

External ID એ તમારી સિસ્ટમમાંથી સ્થિર સંપર્ક ઓળખકર્તા છે: a CRM ID, ગ્રાહક UUID, ફોન નંબર અથવા ઈમેલ. અપરિવર્તનશીલ સિસ્ટમ ID પસંદ કરો. સમગ્ર સિસ્ટમમાં અથડામણ ટાળવા અને વેબહૂક સહસંબંધને સ્પષ્ટ બનાવવા માટે વૈકલ્પિક રીતે External Source ઉમેરો.

નમૂના પસંદગી

જ્યારે પ્રોફાઇલમાં એક સક્રિય નમૂનો હોય, ત્યારે template_id અવગણી શકાય છે અને 7stamp તેને આપમેળે પસંદ કરે છે. જ્યારે તેની પાસે બહુવિધ સક્રિય નમૂનાઓ હોય, ત્યારે ઇચ્છિત template_id પાસ કરો. અનુમાનિત ID હાર્ડ-કોડ કરવાને બદલે પહેલા GET /templates વાંચો.

ન્યૂનતમ પ્રમાણિત વિનંતી: એક આમંત્રણ બનાવો

આને તમારા ઓટોમેશન સ્ટેપમાં કૉપિ કરો bash
curl -X POST "https://api.7loc.com/cards-api/cards/invite" \
  -H "Authorization: Bearer YOUR_7STAMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "crm_contact_8821",
    "external_source": "hubspot",
    "template_id": 42
  }'

API કી થી પ્રથમ સફળ વિનંતી માટે

01

7stamp Admin માં સાઇન ઇન કરો અને એક કી બનાવો: API Integrations → API KeysAdd API Key. તેને તમારા સિક્રેટ મેનેજરમાં સ્ટોર કરો, સોર્સ કોડ અથવા ક્લાયન્ટ-સાઇડ એપ્લિકેશનમાં નહીં.

02

આધાર URL ને https://api.7loc.com/cards-api પર સેટ કરો અને Authorization ઉમેરો: Bearer દરેક સર્વર-સાઇડ વિનંતીની કી દ્વારા અનુસરવામાં આવે છે.

03

પહેલા GET /templates પર કૉલ કરો. સફળ પ્રતિસાદ ટોકનની પુષ્ટિ કરે છે અને તે કાર્યસ્થળ પર ઉપલબ્ધ નમૂનાઓ બતાવે છે/profile.

04

તમારી પોતાની સિસ્ટમમાંથી સ્થિર External ID અને વૈકલ્પિક External Source પસંદ કરો. બનાવો, સ્કેન કરો, લુકઅપ કરો અને વેબહૂક લોજિકમાં ચોક્કસ સમાન ઓળખ જોડીનો ઉપયોગ કરો.

05

નિકાલજોગ પરીક્ષણ સંપર્ક સાથે POST /cards/invite પર કૉલ કરો. વાસ્તવિક ગ્રાહકોને સ્વચાલિત ડિલિવરી કરતા પહેલા પરત કરેલ ઇન્સ્ટોલ URL ચકાસો.

06

POST /cards/scan, વાઉચર, અથવા સંદેશ ક્રિયાઓ તમારા પોતાના બેકએન્ડમાં લોગીંગ, એરર હેન્ડલિંગ અને સુરક્ષિત પુનઃપ્રયાસ/idempotency વ્યૂહરચના કર્યા પછી જ ઉમેરો.

કરાર તરીકે API સંદર્ભનો ઉપયોગ કરો

સાર્વજનિક Swagger/OpenAPI સંદર્ભ વર્તમાન અંતિમ બિંદુ, પરિમાણ, વિનંતી-બોડી, પ્રતિભાવ અને વેબહૂક સ્કીમા ધરાવે છે. ઇન્ટરેક્ટિવ URL https://api.7loc.com/cards-api/docs છે અને મશીન-વાંચી શકાય તેવો કરાર https://api.7loc.com/cards-api/openapi.json. છે, ભૂલ હેન્ડલિંગ અમલમાં મૂકતા પહેલા અથવા વૈકલ્પિક ક્ષેત્રો ઉમેરતા પહેલા તેને વાંચો.

પ્રમાણીકરણ અને કી સલામતી

કી સર્વર-સાઇડ સિક્રેટ છે. તેને બ્રાઉઝર JavaScript, મોબાઈલ એપ બંડલ, સાર્વજનિક ફોર્મ, સ્ક્રીનશૉટ્સ, Make/Zapier ટેક્સ્ટ ફીલ્ડ્સ અથવા સપોર્ટ ટિકિટમાં પ્રદર્શિત કરશો નહીં. સર્વર, સુરક્ષિત ઓટોમેશન કનેક્શન અથવા સિક્રેટ મેનેજરનો ઉપયોગ કરો. જો કી ક્યારેય આકસ્મિક રીતે શેર કરવામાં આવી હોય, તો તેને 7stamp Admin માં રદ કરો અથવા ફેરવો અને અસરગ્રસ્ત કનેક્શન અપડેટ કરો.

વારંવાર પૂછાતા પ્રશ્નો

મને 7stamp API ટોકન ક્યાંથી મળશે?

7stamp Admin માં, API Integrations → API Keys → Add API Key પર જાઓ. ટોકન પછી Authorization હેડરમાં Bearer તરીકે મોકલવામાં આવે છે અને ત્યારબાદ કી.

આધાર URL અને પ્રમાણીકરણ પદ્ધતિ શું છે?

https://api.7loc.com/cards-api નો ઉપયોગ કરો અને Authorization મોકલો: Bearer YOUR_7STAMP_API_KEY દરેક અધિકૃત વિનંતી પર.

હું template_id ક્યારે છોડી શકું?

ફક્ત ત્યારે જ જ્યારે કનેક્ટેડ પ્રોફાઇલમાં બરાબર એક સક્રિય કાર્ડ ટેમ્પલેટ હોય. જો બહુવિધ નમૂનાઓ સક્રિય હોય, તો GET /templates.

Should I use the API, Make, or Zapier?

કસ્ટમ POS, બેકએન્ડ, સાઇટ અથવા સંપૂર્ણ નિયંત્રણ માટે API નો ઉપયોગ કરો. વિઝ્યુઅલ બ્રાન્ચિંગ દૃશ્યો માટે Make નો ઉપયોગ કરો. મોટે ભાગે રેખીય ટ્રિગર-એક્શન વર્કફ્લો માટે Zapier નો ઉપયોગ કરો. ત્રણેય સમાન API કી અને API કરાર પર આધાર રાખે છે.

આગલું પગલું

સૌથી નાના સલામત ⟧907 પ્રથમ પ્રવાહનું પરીક્ષણ કરો

કી બનાવો, GET /templates પર કૉલ કરો, નિકાલજોગ સંપર્ક માટે એક આમંત્રણ બનાવો, પછી સાબિત વિનંતીની આસપાસ ઉત્પાદન રહસ્યો, લોગીંગ, ફરીથી પ્રયાસો અને વેબહુક હેન્ડલિંગ ઉમેરો.