Մշակողի ինտեգրում

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-ի և 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 & Integrations էկրանը, որը ցույց է տալիս 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, ստեղծեք մեկ հրավեր միանգամյա օգտագործման կոնտակտի համար, այնուհետև ավելացրեք արտադրության գաղտնիքները, գրանցումը, կրկնվող փորձերը և վեբ-կապիկի մշակումը ապացուցված հարցման շուրջ: