დეველოპერის ინტეგრაცია

7stamp REST API

ხელმისაწვდომია

7stamp Integration API საშუალებას აძლევს CRM-ს, ელექტრონული კომერციის პლატფორმას, POS-ს, მორგებულ უკანა პლატფორმას ან ავტომატიზაციის ხელსაწყოს, მართოს საფულის ლოიალობის ბარათები საკონტაქტო იდენტიფიკატორით, რომელსაც თქვენი სისტემა უკვე იყენებს. ეს არის უნივერსალური ვარიანტი, როდესაც სპეციალიზებული ინტეგრაცია არ არსებობს.

API საბაზისო URL არის https://api.7loc.com/cards-api. ყოველი მოთხოვნის ავტორიზაცია API გასაღებით, როგორც Bearer ჟეტონი. გამოიყენეთ დაკავშირებული OpenAPI მითითება პირდაპირი მოთხოვნისა და პასუხების სქემებისთვის წარმოების ლოგიკის აშენებამდე.

რისი გაკეთება შეგიძლიათ API-ით

API არის ინტეგრაციის სტეკის ჩაწერის მხარე. გამოიყენეთ იგი ყოველთვის, როცა თქვენი საკუთარი პროგრამული უზრუნველყოფა უნდა დარჩეს ჭეშმარიტების ოპერატიული წყარო, ხოლო 7stamp ამუშავებს საფულის ლოიალობის ფენას.

გაუშვით ბარათები თქვენი საკუთარი პროგრამული უზრუნველყოფით

შექმენით პერსონალური საფულის ბარათის ბმული თქვენი სისტემის ნებისმიერი მომხმარებლისთვის. მიაწოდეთ ის თქვენი საკუთარი ელფოსტის, SMS, Push-ის ან აპს-შიდა ნაკადის საშუალებით. მომხმარებელი ხსნის ბმულს და ინახავს ბარათს Apple Wallet ან Google Wallet.

საკრედიტო მარკები ნებისმიერი წყაროდან

როდესაც შესყიდვა იხურება თქვენს მორგებულ POS-ში, როდესაც ონლაინ შეკვეთა გადაიხდება თქვენს ვებსაიტზე, ან როდესაც სერვისი დასრულდება თქვენს ჯავშნის სისტემაში, დარეკეთ API საკრედიტო მარკებზე. ბარათი განახლდება წამებში.

ვაუჩერებისა და კამპანიების მართვა

გასცეს ერთჯერადი ვაუჩერი კონკრეტულ მომხმარებელს, შექმენით კამპანიისთვის მზა ჯილდოს ნაკადები და დააბრუნეთ ვაუჩერის სტატუსი იმ სისტემებში, რომლებიც ამუშავებენ ფინანსებს და მომსახურების ხარისხს.

დოკუმენტირებული ინტეგრაცია API ოპერაციები

ეს არის საჯარო API მარშრუტები Make6 მოქმედების უკან. წაიკითხეთ ზუსტი სქემა 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 & Integrations, დაამატეთ გასაღები, შემდეგ დააკოპირეთ ის უსაფრთხო სერვერის საიდუმლო ან ავტომატიზაციის კავშირში.

7stamp Admin API & ინტეგრაციების ეკრანი, რომელიც აჩვენებს Add API Key ღილაკს და გენერირება API გასაღების დიალოგი
Step 1 — Select API & Integrations in the left navigation, open API Keys, choose Add API Key, select the appropriate staff login, and generate the key.
7stamp Admin დიალოგი, რომელიც აჩვენებს ახლად გენერირებულ API კლავიშს და მის ასლის კონტროლს
ნაბიჯი 2 — დააკოპირეთ ახალი გასაღები პაროლის მენეჯერში, სერვერის მხარეს საიდუმლოში ან უსაფრთხო Make/Zapier კავშირში. არ ჩასვათ ის წყაროს კოდში, ბრაუზერის აპლიკაციაში ან მხარდაჭერის ბილეთში.

სამი გადაწყვეტილების მიღება კოდირებამდე

API გასაღების ფარგლები

შექმენით გასაღები 7stamp Admin-ში API Integrations → API KeysAdd API Key ქვეშ. გასაღები ეკუთვნის ერთ სამუშაო ადგილს/profile, ამიტომ შექმენით ცალკეული გასაღებები განვითარებისა და წარმოებისთვის, როცა თქვენი ანგარიშის დაყენება ამის საშუალებას მოგცემთ. მოატრიალეთ ან გააუქმეთ წვდომა საინფორმაციო დაფიდან, თუ საიდუმლო გამჟღავნდება.

მომხმარებლის იდენტიფიკაცია

External ID არის სტაბილური საკონტაქტო იდენტიფიკატორი თქვენი სისტემისგან: CRM ID, კლიენტის UUID, ტელეფონის ნომერი ან ელფოსტა. უპირატესობა მიანიჭეთ უცვლელ სისტემას ID. სურვილისამებრ, დაამატეთ External Source, რათა თავიდან აიცილოთ შეჯახება სისტემებში და გახადოთ ვებჰუკის კორელაცია აშკარა.

შაბლონის შერჩევა

როდესაც პროფილს აქვს ერთი აქტიური შაბლონი, template_id შეიძლება გამოტოვდეს და 7stamp ირჩევს მას ავტომატურად. როდესაც მას აქვს მრავალი აქტიური შაბლონი, გაიარეთ განკუთვნილი template_id. ჯერ წაიკითხეთ GET /templates, ვიდრე გამოცნობილი ID მყარი კოდირება.

მინიმალური ავტორიზებული მოთხოვნა: შექმენით მოწვევა

დააკოპირეთ ეს თქვენს ავტომატიზაციის ეტაპზე 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?

მხოლოდ მაშინ, როდესაც დაკავშირებულ პროფილს აქვს ზუსტად ერთი აქტიური ბარათის შაბლონი. თუ რამდენიმე შაბლონი აქტიურია, აირჩიეთ სწორი template_id GET /templates.-დან

უნდა გამოვიყენო API, Make ან Zapier?

გამოიყენეთ API მორგებული POS, ბექენდის, საიტის ან სრული კონტროლისთვის. გამოიყენეთ Make ვიზუალური განშტოების სცენარებისთვის. გამოიყენეთ Zapier ძირითადად წრფივი ტრიგერული მოქმედების სამუშაო ნაკადისთვის. სამივე ეყრდნობა ერთსა და იმავე API გასაღებს და API კონტრაქტს.

შემდეგი ნაბიჯი

ჯერ შეამოწმეთ ყველაზე პატარა უსაფრთხო API ნაკადი

შექმენით გასაღები, დარეკეთ GET /templates, შექმენით ერთი მოწვევა ერთჯერადი კონტაქტისთვის, შემდეგ დაამატეთ წარმოების საიდუმლოებები, ჟურნალი, ხელახალი ცდები და ვებ-კაკუს დამუშავება დადასტურებული მოთხოვნის გარშემო.