Գաղտնիք չէ, որ push ծանուցումները կարող են օգնել ձեզ ներգրավել և պահպանել հավելվածի օգտատերերին: Այս ձեռնարկում մենք ձեզ ցույց կտանք, թե ինչպես օգտագործել OneSignal NodeJS Client SDK-ն՝ համագործակցելու OneSignal-ի բոլոր գործառույթների հետ, որոնք դուք հասանելի եք մեր REST API-ում, բայց մենք ձեզ ավելի հեշտ դարձրինք այս փաթաթանով:
OneSignal NodeJS Client SDK-ի օգտագործումը շատ օգտակար է, քանի որ այն կարող է օգնել ձեզ ինտեգրել OneSignal-ը տարբեր աշխատանքային հոսքերի մեջ, որոնք կարող են ունենալ ձեր հավելվածները:
Օգտակար ռեսուրսներ.
- Ինչպես ուղարկել push ծանուցում OneSignal REST API-ի միջոցով
- OneSignal Փոստատարի հավաքածու
- Ուսուցողական Github Repo
OneSignal և ձեր զննարկչի Push API-ն
Push API-ն հավելվածներին հնարավորություն է տալիս հաղորդագրություններ ստանալ սերվերից՝ անկախ նրանից, որ հավելվածը գտնվում է առաջին պլանում կամ ներկայումս բեռնված է օգտատերերի գործակալի վրա: Սա թույլ է տալիս ասինխրոն ծանուցումներ և թարմացումներ տրամադրել օգտատերերին, ովքեր միացել են, ինչը հանգեցնում է ժամանակին նոր բովանդակության հետ ավելի լավ ներգրավվածության:
Այս ձեռնարկը կներառի մեր API-ի օգտագործման ակնարկը OneSignal NodeJS Client SDK-ով:
Ուղեցույցի ակնարկ
Այս ձեռնարկը պահանջում է որոշ հիմնական գիտելիքներ NodeJS-ի և REST API-ների օգտագործման մասին: Ես օգտագործում եմ OneSignal հաշիվը հետևյալի հետ միասին.
- Հավելված՝ ինտեգրված OneSignal-ով (բջջային, վեբ կամ խաղ)
- NPM (ես օգտագործում եմ NPM տարբերակը v6.14.11)
- NodeJS (ես օգտագործում եմ NodeJS v16.14.2)
Մաս 1. OneSignal REST API-ի ակնարկ
Ծանուցումների ուղարկում
OneSignal Push API-ն թույլ է տալիս ծրագրային կերպով ուղարկել push notifications: Push ծանուցումները կարող են ուղարկվել տարբեր սեգմենտներ (ըստ լռելյայն, դուք դրանք ուղարկում եք բոլոր բաժանորդագրված օգտատերերին) և նույնիսկ հատուկ սարքերի` օգտագործելով User ID-ը: OneSignal REST API-ի մեկ այլ հետաքրքիր առանձնահատկությունը պլանավորված ծանուցումները չեղարկելու հնարավորությունն է:
Դիտել ծանուցումը
OneSignal REST API-ի հետ օգտագործելու իմ սիրելի վերջնակետերից մեկը դիտման ծանուցման վերջնակետն է: Այս վերջնակետը թույլ է տալիս տեղեկատվություն հավաքել դրանց հետ կապված ծանուցումների և արդյունքների մասին: Օրինակ, վերադարձված տվյալները կարող են ձեզ ասել, թե տեսնում եք չուղարկված ծանուցումների քանակը, առաքված ծանուցումների քանակը, հաստատված առաքումների քանակը և շատ ավելին: Եթե ցանկանում եք ավելին իմանալ այս վերջնակետով վերադարձված տվյալների մասին, այցելեք մեր մնացած API հղումը:
Մեր API-ն կարող է ավելին անել, քան պարզապես ծանուցում ուղարկելը և այդ ծանուցման տվյալները դիտելը: Եթե ցանկանում եք ավելին իմանալ մեր ամբողջ REST API-ի մասին, այցելեք OneSignal REST API-ի ակնարկ էջը:
NodeJS հաճախորդների գրադարանի ամենահիասքանչ բանն այն է, որ դուք կարիք չունեք անհանգստանալու ձեր NodeJS նախագծում REST API-ի ամբողջ կարգավորումից, մենք կառավարում ենք ամբողջ կաթսայատունը, որպեսզի դուք չանհանգստանաք դրա մասին;)
Ձեր NodeJS հավելվածի ստեղծում
Ձեր տերմինալի ներսում գործարկեք հետևյալ հրամանները՝ NPM-ի միջոցով նոր NodeJS նախագիծ ստեղծելու համար.
npm init
Նախորդ npm հրամանը մուտքագրելուց հետո պատասխանեք բոլոր հարցերին, որոնք կհայտնվեն ձեր տերմինալում: Այս հարցերը կստեղծեն ձեր package.json
արժեքները:
Ձեր package.json ֆայլը նման կլինի հետևյալին.
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
Համոզվեք, որ ավելացնում եք տիպի հատկությունը:
Մաս 2. Push Notifications NodeJS-ում
Կարգավորեք ձեր NodeJS հավելվածը
Առաջին բանը, որ դուք պետք է անեք, index.js ֆայլ ստեղծելն է: Այս ֆայլը կպարունակի բոլոր կոդը, որոնք անհրաժեշտ են ձեր ծանուցումները ուղարկելու և դիտելու համար:
Այս ֆայլի վերևում ավելացրեք հարցման npm փաթեթը: Այս փաթեթը կօգնի մեզ API-ի զանգեր կատարել OneSignal-ի վերջնակետերին ավելի հեշտ եղանակով, քան NodeJS-ի միջոցով:
import * as OneSignal from '@onesignal/node-onesignal';
Այժմ գործարկեք npm install @onesignal/node-onesignal --save
ը՝ OneSignal NodeJS SDK Client
NPM փաթեթը ձեր նախագծին ավելացնելու համար: OneSignal NPM փաթեթը տեղադրելուց հետո ձեր index.js-ին ավելացրեք հետևյալ փոփոխականը OneSignal ներմուծումից հետո:
const ONE_SIGNAL_APP_ID = 'ONESIGNAL_APP_ID';
Ինչպե՞ս ստանալ API KEY-ը և APP ID-ն OneSignal-ից: Նավարկեք դեպի OneSignal Dashboard և նավարկեք դեպի այն հավելվածը, որը ստեղծել եք OneSignal-ի ներսում: Երբ ընտրեք այն հավելվածը, որի հետ ցանկանում եք աշխատել այս ուղեցույցի ընթացքում, վահանակի էջը կբացվի:
Անցեք կարգավորումների էջ՝ սեղմելով S _ կարգավորումներ _ ներդիրը:
Կարգավորումների ներսում կտտացրեք «Ստեղներ և նույնականացումներ»: Այս էջում դուք կտեսնեք ձեր OneSignal հավելվածի ID-ն և ձեր API բանալին:
Այժմ, երբ դուք գտնվում եք Կարգավորումներ › Ստեղներ և IDs ներդիրում, կարող եք պատճենել OneSignal հավելվածի ID-ն և REST API KEY-ը:
Նշում. OneSignal հավելվածի ID-ին մուտք գործելու մեկ այլ արագ միջոց է այն պատճենել URL-ից:
Հիշեք, որ եթե ցանկանում եք ծրագիր ստեղծել OneSignal NodeJS Client-ի միջոցով, ձեզ անհրաժեշտ կլինի User Authentication Key:
Token Builder
Հավելվածը նույնականացնելու համար ձեզ հարկավոր է օգտագործել ձեր OneSignal REST API ստեղնը: Ստեղծեք բանալի մատակարարող օբյեկտ getToken()
ֆունկցիայով, որը վերադարձնում է ձեր բանալին:
Վերադարձնում է. Ձեր բանալին: Հետին պլանում, երբ դուք օգտագործում եք այս փոփոխականը, գործարկվում է app_key_provider.getToken()
:
const app_key_provider = {
getToken() {
return 'ONESIGNAL_REST_API_KEY';
}
};
Հաճախորդի կոնֆիգուրացիա
Մենք կարող ենք կարգավորել հաճախորդը՝ օգտագործելով createConfiguration()
ֆունկցիան: Կազմաձևման օբյեկտը կարող է օգտագործվել app_key_provider
հատկությունները սահմանելու համար:
const configuration = OneSignal.createConfiguration({
authMethods: {
user_key: {
tokenProvider: user_key_provider
},
app_key: {
tokenProvider: app_key_provider
}
}
});
const client = new OneSignal.DefaultApi(configuration);
Ստեղծել ծանուցում
Ստեղծեք push ծանուցում և ուղարկեք այն ձեր հավելվածի օգտատերերին:
Push ծանուցում ուղարկելու համար դուք կավելացնեք հետևյալ գործառույթը, որը զանգ կկատարի OneSignal REST API-ին: Այս գործառույթը վերցնում է մարմնի պարամետր, որը ներկայացնում է այն տեղեկատվությունը, որը կպարունակի push ծանուցումը:
const notification = new OneSignal.Notification();
notification.app_id = ONESIGNAL_APP_ID;
notification.included_segments = ['Subscribed Users'];
notification.contents = {
en: "Hello OneSignal!"
};
const {id} = await client.createNotification(notification);
Ուշադրություն դարձրեք, որ մենք օգտագործում ենք օբյեկտների ապակառուցում ծանուցման ID-ն ID կոչվող փոփոխականում պահելու համար:
Դիտել ծանուցումը
Ծանուցում ուղարկելուց հետո դիտեք ծանուցման տեղեկատվությունը և դրա հետ կապված արդյունքները՝ օգտագործելով ծանուցման ID-ն:
Ինչպես տեսնում եք, ես որպես երկրորդ պարամետր փոխանցում եմ id
փոփոխականը, որը պարունակում է ծանուցման id այն բանից հետո, երբ ես ստեղծել եմ ծանուցումը createNotification()
մեթոդով:
const response = await client.getNotification(ONESIGNAL_APP_ID, id);
Գործարկեք ձեր կոդը
Մեր package.json
-ի շնորհիվ դուք կկարողանաք գործարկել ձեր nodejs կոդը՝ բացելով ձեր տերմինալը և մուտքագրելով npm run start
: Այս հրամանը գործարկելուց հետո դուք պետք է տեսնեք ծանուցում, որը կհայտնվի ձեր սարքում, եթե և միայն այն դեպքում, եթե դուք բաժանորդագրվել եք ձեր ստեղծած կայքի, խաղի կամ հավելվածի ծանուցումներին և գրանցել այն OneSignal Dashboard-ում:
Ազատորեն փորձարկեք NodeJS Client SDK-ի այլ մեթոդներ և տեղեկացրեք մեզ, թե ինչ եք մտածում:
Ցանկանու՞մ եք ավելին իմանալ OneSignal արտադրանքի և այլ տեխնոլոգիաների մասին: Միացե՛ք մեր OneSignal ծրագրավորողների համայնքին:
Միացեք OneSignal Developers համայնքին
OneSignal Developer համայնքը կրքոտ անհատների խումբ է, ովքեր աշխատում են OneSignal արտադրանքների հետ: Համայնքի անդամները հնարավորություն ունեն ընդլայնելու իրենց ցանցը և գիտելիքները տարբեր տեխնոլոգիաների միջոցով:
Միացեք Twitter-ում
Հետևեք մեր OneSignal Developers Twitter-ին՝ ավելին իմանալու OneSignal-ի, տեխնիկական խորհուրդների և OneSignal ծրագրավորողների վերջին իրադարձությունների մասին:
Միացեք մեր Discord սերվերին
OneSignal Developer համայնքը հավաքվում է մեր հանրային զրույցի սերվերում, որը հասանելի է Discord-ում: Մեր Discord սերվերը անվտանգ միջավայր է այլ անդամների հետ կապ հաստատելու, հարցեր տալու և միմյանցից սովորելու համար: Այն նաև վայր է OneSignal-ի արտադրանքի մշակման թիմի հետ ներգրավվելու համար:
Դուք ներկայումս օգտագործում եք հիմնական նշագրման խմբագրիչը, որն օգտագործում է Jekyll առջևի նյութը: Կարող եք նաև օգտագործել rich+markdown խմբագրիչը, որը կարող եք գտնել UX-ի կարգավորումներում:
Խմբագրի հիմունքներ
Օգտագործեք Markdown՝ գրառումները գրելու և ձևաչափելու համար:
Սովորաբար օգտագործվող շարահյուսություն
Ներկառուցեք հարուստ բովանդակություն, ինչպիսիք են Թվիթեր, YouTube-ի տեսանյութեր և այլն: Օգտագործեք ամբողջական URL-ը. {% ներդրեք https://... %}: Դիտեք աջակցվող ներկառուցումների ցանկը:
Բացի գրառման բովանդակության պատկերներից, կարող եք նաև քաշել և թողնել շապիկի պատկերը:
Պահպանել փոփոխությունները
Վերականգնել նոր փոփոխությունները
Ավելացնել ֆայլ
Թարմացրեք գաղտնի էությունը Չեղարկել
- © 2022 GitHub, Inc.
- "Պայմանները"
- Գաղտնիություն
- Անվտանգություն
- Կարգավիճակ
- Փաստաթղթեր
- Կապ GitHub
- Գին
- API
- Ուսուցում
- Բլոգ
- "Մասին"