డెవలపర్ ఇంటిగ్రేషన్

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 కార్యకలాపాలు

ఇవి పబ్లిక్ STMXTON4 పబ్లిక్ STMXTON మార్గాలు Zapier చర్యలు. 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 — APIలో ఇన్‌టెగ్విరేషన్‌ని తెరిచి, ఎడమవైపు నావిగేషన్‌ని ఎంచుకోండి API Keys, Add API Keyని ఎంచుకుని, తగిన స్టాఫ్ లాగిన్‌ని ఎంచుకుని, కీని రూపొందించండి.
7stamp Admin డైలాగ్ కొత్తగా రూపొందించబడిన API కీని చూపుతుంది మరియు దాని కాపీ నియంత్రణ
దశ 2 — కొత్త కీని పాస్‌వర్డ్ మేనేజర్, సర్వర్ వైపు రహస్యం లేదా సురక్షిత Make/Zapier కనెక్షన్‌కి కాపీ చేయండి. దీన్ని సోర్స్ కోడ్, బ్రౌజర్ అప్లికేషన్ లేదా సపోర్ట్ టికెట్‌లో అతికించవద్దు.

Three decisions to make before coding

API కీ స్కోప్

API Integrations → API KeysAdd API Key కింద 7stamp Adminలో కోడింగ్ చేయడానికి ముందు మూడు నిర్ణయాలు తీసుకోవాలి ఒక కీ ఒక కార్యాలయానికి చెందినది/profile, కాబట్టి మీ ఖాతా సెటప్ అనుమతించినప్పుడు అభివృద్ధి మరియు ఉత్పత్తి కోసం ప్రత్యేక కీలను సృష్టించండి. రహస్యం బహిర్గతమైతే డాష్‌బోర్డ్ నుండి యాక్సెస్‌ని తిప్పండి లేదా ఉపసంహరించుకోండి.

కస్టమర్ గుర్తింపు

External ID అనేది మీ సిస్టమ్ నుండి స్థిరమైన కాంటాక్ట్ ఐడెంటిఫైయర్: ఒక CRM ID, కస్టమర్ UUID, ఫోన్ నంబర్ లేదా ఇమెయిల్. మార్పులేని సిస్టమ్ IDని ఇష్టపడండి. సిస్టమ్‌లలో ఘర్షణలను నివారించడానికి మరియు వెబ్‌హుక్ సహసంబంధాన్ని స్పష్టంగా చేయడానికి External Sourceని ఐచ్ఛికంగా జోడించండి.

టెంప్లేట్ ఎంపిక

ప్రొఫైల్‌లో ఒక సక్రియ టెంప్లేట్ ఉన్నప్పుడు, template_id విస్మరించబడుతుంది మరియు 7stamp దాన్ని స్వయంచాలకంగా ఎంచుకుంటుంది. ఇది బహుళ క్రియాశీల టెంప్లేట్‌లను కలిగి ఉన్నప్పుడు, ఉద్దేశించిన template_idని పాస్ చేయండి. ఊహించిన IDని హార్డ్-కోడింగ్ చేయకుండా ముందుగా GET /templatesని చదవండి.

Minimal authenticated request: create an invite

దీన్ని మీ ఆటోమేషన్ దశకు కాపీ చేయండి 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
  }'

ఆహ్వానాన్ని సృష్టించండి

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 ఒప్పందంపై ఆధారపడతాయి.

తదుపరి దశ

Test the smallest safe API flow first

కీని సృష్టించండి, GET /templatesకి కాల్ చేయండి, డిస్పోజబుల్ కాంటాక్ట్ కోసం ఒక ఆహ్వానాన్ని సృష్టించండి, ఆపై నిరూపితమైన అభ్యర్థన చుట్టూ ఉత్పత్తి రహస్యాలు, లాగింగ్, రీట్రీలు మరియు వెబ్‌హుక్ హ్యాండ్లింగ్‌ను జోడించండి.