Relay-ի կարգավորման ուղեցույց
Հետևեք բաժիններին նշված հերթականությամբ՝ ձեր հաշիվը, Application-ների հասանելիությունը, հաղորդագրությունների ուղարկումը, ելքային առաքումը, bounce-երի մշակումը, tracking-ը, suppression-ները, webhooks-ը և համապատասխանության գործընթացները կարգավորելու համար։
01. Ակտիվացրեք ձեր հաշիվը և ուսումնասիրեք փաթեթի սահմանաչափերը
Սկսեք՝ ակտիվացնելով այն կազմակերպությունը, որին պատկանելու են ձեր Relay-ի օգտատերերը, Applications-ը, հավատարմագրերը, հաղորդագրությունները, webhooks-ը, suppression-ները և համապատասխանության հարցումները։
Ինչ անել
- Ստեղծեք ձեր Ridgital հաշիվը։
- Հաստատեք ձեր էլփոստի հասցեն։
- Ընտրեք և գնեք Relay փաթեթ։
- Համոզվեք, որ բաժանորդագրությունն ակտիվ է։
- Նախքան ռեսուրսներ ստեղծելը՝ ուսումնասիրեք ձեր փաթեթի սահմանաչափերը։
Ինչ է վերահսկում ձեր փաթեթը
- Էլփոստային հաղորդագրությունների ամսական և օրական ծավալը։
- API-ի և SMTP-ի արագության սահմանաչափերը։
- Հաղորդագրությունների և իրադարձությունների պահպանման ժամկետները։
- Applications-ի, API Keys-ի, SMTP հավատարմագրերի և webhooks-ի քանակը։
- Կցորդների և հաղորդագրության չափի սահմանաչափերը։
- Tracking-ը, suppression-ները, համապատասխանության գործառույթները և աջակցության մակարդակը։
Կազմակերպության հասանելիություն
Administrator հասանելիություն տրամադրեք միայն այն օգտատերերին, որոնց անհրաժեշտ է կառավարել հավատարմագրերը, օգտատերերին, ուղարկողի դոմենները, suppression-ները, webhooks-ը, արտահանումները կամ ստացողի տվյալների ջնջման հարցումները։ Այս հաշիվների համար միացրեք երկգործոն նույնականացումը։
02. Ստեղծեք Applications և API Keys
Applications-ը օգնում են նույն Relay կազմակերպության ներսում տարանջատել պրոդուկտներն ու միջավայրերը։ API Keys-ը թույլատրում են սերվերային հարցումները Relay API-ին։
Ստեղծեք Application
- Բացեք Relay → Applications բաժինը։
- Ընտրեք Add Application։
- Մուտքագրեք հեշտ ճանաչելի անուն։
- Ցանկության դեպքում ավելացրեք նկարագրություն։
- Production և Staging միջավայրերի համար ստեղծեք առանձին Applications, երբ դրանց գործունեությունն ու հավատարմագրերը պետք է միմյանցից անկախ մնան։
Ընտրեք ճիշտ scope-ը
Այն դեպքերում, երբ Relay-ը տրամադրում է scope-ի ընտրիչ, ռեսուրսը կապեք որոշակի Application-ի հետ կամ ընտրեք Account-wide, երբ ռեսուրսը պետք է հասանելի լինի ամբողջ կազմակերպությունում։
Ստեղծեք API Key
- Բացեք Account → API Keys բաժինը։
- Ընտրեք Create API Key։
- Մուտքագրեք անուն, որը նույնականացնում է դրա Application-ը և միջավայրը։
- Ցանկության դեպքում սահմանեք գործողության ավարտի ամսաթիվ։
- Անմիջապես պատճենեք ստեղծված բանալին։
Պաշտպանեք ստեղծված բանալին
- Ամբողջական API Key-ը ցուցադրվում է միայն մեկ անգամ։
- Պահեք այն գաղտնիքների կառավարման համակարգում կամ սերվերային միջավայրի փոփոխականում։
- Երբեք մի բացահայտեք այն դիտարկիչի կոդում, բջջային հավելվածներում, կոդային շտեմարաններում կամ log-երում։
- Բանալին չեղարկելու դեպքում դրա գործողությունն անմիջապես դադարում է, և այդ գործողությունը հնարավոր չէ հետ շրջել։
03. Ուղարկեք էլփոստ HTTP API-ի միջոցով
API կապ
HTTPS-ի միջոցով հարցումներ ուղարկեք https://ridgital.com/api/v1 հասցեին և յուրաքանչյուր հարցում նույնականացրեք հետևյալով․
Authorization: Bearer rdg_<your_api_key>
Բացակայող, ժամկետանց, չեղարկված կամ անվավեր բանալու դեպքում վերադարձվում է 401 Unauthorized։
Ստուգեք API հասանելիությունը
GET /relay/ping
Նախ օգտագործեք այս endpoint-ը՝ API-ի հասանելիությունը հաստատելու և API Key-ը վավերացնելու համար։
Ուղարկեք մեկ հաղորդագրություն
POST /relay/send
Հաջող պատասխանը նշանակում է, որ Relay-ն ընդունել է հաղորդագրությունը և այն ավելացրել հերթում։ Դա չի նշանակում, որ առաքումն ավարտվել է։
Ուղարկեք batch
POST /relay/send/batch
Մեկ հարցմամբ ուղարկեք մինչև 100 հաղորդագրություն։ Relay-ը յուրաքանչյուր տարրի համար վերադարձնում է առանձին արդյունք։
Ստացեք մեկ հաղորդագրության տվյալները
GET /relay/messages/{message_id}
Ստացեք ուղարկված հաղորդագրության ընթացիկ canonical կարգավիճակը և գրանցված կյանքի ցիկլը։
Ցուցադրեք ուղարկված հաղորդագրությունների ցանկը
GET /relay/emails
Ցուցադրեք և զտեք ձեր ուղարկած հաղորդագրությունները։ Արդյունքները բաժանված են էջերի։
Ասինխրոն մշակում
Առաքման փորձերը, կրկնակի փորձերը, bounce-երի մշակումը, suppression-ները, tracking իրադարձությունները և webhook ծանուցումները կատարվում են ուղարկման սկզբնական պատասխանից հետո։
04. Ուղարկեք էլփոստ SMTP ingress-ի միջոցով
Օգտագործեք SMTP ingress-ը CRM-ների, հին հավելվածների կամ երրորդ կողմի համակարգերի համար, որոնք չեն կարող հաղորդագրություններ ուղարկել HTTP API-ի միջոցով։
Ստեղծեք հավատարմագիրը
- Բացեք Relay → SMTP Ingress բաժինը։
- Ընտրեք Add Credential։
- Մուտքագրեք Application-ը նույնականացնող պիտակ։
- Ստեղծեք հավատարմագիրը։
- Անմիջապես պահպանեք ստեղծված օգտանունն ու գաղտնաբառը։
Կարգավորեք Application-ը
- Օգտագործեք պորտալում ցուցադրված SMTP ingress host-ը։
- Օգտագործեք 587 port-ը։
- Օգտագործեք STARTTLS։
- Նույնականացումն իրականացրեք Relay-ի ստեղծած օգտանունով և գաղտնաբառով։
Հավատարմագրի կյանքի ցիկլը
Ստեղծված գաղտնաբառը ցուցադրվում է միայն մեկ անգամ։ Դրա rotation-ը նախորդ գաղտնաբառն անմիջապես անվավեր է դարձնում։ Հավատարմագրի չեղարկումը վերջնական է և Application-ին անմիջապես զրկում է նույնականացման հնարավորությունից։
SMTP ingress հավատարմագրերը ձեր Application-ը կապում են Relay-ին։ Դրանք Delivery SMTP հավատարմագրեր չեն։
05. Կարգավորեք ելքային Delivery SMTP-ն
Delivery SMTP-ն ելքային կապն է, որն օգտագործում է Relay-ը՝ մշակված հաղորդագրությունները ձեր էլփոստային ծառայություն մատուցողին փոխանցելու համար։
Ստեղծեք կարգավորումը
- Բացեք Relay → Delivery SMTP բաժինը։
- Ընտրեք Add SMTP Config։
- Մուտքագրեք ձեր ելքային էլփոստի ծառայություն մատուցողի տրամադրած ճշգրիտ արժեքները։
- Պահպանեք կարգավորումը։
- Գործարկեք Test Connection-ը։
- Նախքան production միջավայրում օգտագործելը՝ շտկեք կապի բոլոր սխալները։
Տարբերակում և կարգավիճակ
- Name: նույնականացնում է կապը Relay-ում։
- Active: որոշում է՝ արդյոք Relay-ը կարող է օգտագործել այն։
- Default: նշում է այն որպես նախատեսված հիմնական կապ։
Սերվերի միացում
- Host: ծառայություն մատուցողի SMTP hostname-ը։
- Port: ծառայություն մատուցողի SMTP port-ը։
- Encryption: տվյալ port-ի համար պահանջվող ռեժիմը։
Նույնականացում
- Username: SMTP օգտանունը։
- Password: SMTP սերվերի կողմից ընդունվող հավատարմագիրը։
- Խմբագրելիս գաղտնաբառի դաշտը թողեք դատարկ՝ ընթացիկ պահպանված գաղտնաբառը պահելու համար։
Ուղարկողի ինքնություն
- From Email: կարգավորման հետ կապված ուղարկողի հասցեն։
- From Name: ուղարկողի ցուցադրվող անունը։
- Ծառայություն մատուցողը պետք է թույլատրի ընտրված From Email-ը։
Daily Limit
Հաղորդագրությունների առավելագույն քանակը, որը Delivery SMTP-ի այս կարգավորումը կարող է ուղարկել մեկ օրվա ընթացքում։ Դաշտը թողեք դատարկ, եթե կարգավորման մակարդակում օրական սահմանաչափ չի պահանջվում։
Hourly Limit
Հաղորդագրությունների առավելագույն քանակը, որը Delivery SMTP-ի այս կարգավորումը կարող է ուղարկել մեկ ժամվա ընթացքում։ Դաշտը թողեք դատարկ, եթե կարգավորման մակարդակում ժամային սահմանաչափ չի պահանջվում։
Գաղտնագրում և port
STARTTLS-ը սովորաբար օգտագործվում է 587 port-ի հետ։ Անմիջական SSL/TLS-ը սովորաբար օգտագործվում է 465 port-ի հետ։ Օգտագործեք ձեր ծառայություն մատուցողի փաստաթղթերում նշված ճշգրիտ համադրությունը։ Փաթեթի և ծառայություն մատուցողի սահմանաչափերը շարունակում են գործել նաև այն դեպքում, երբ Daily Limit կամ Hourly Limit դաշտը դատարկ է։
06. Կարգավորեք bounce-երի և բողոքների մշակումը
Relay-ն օգտագործում է կարգավորված bounce mailbox-ը՝ SMTP փոխանցումից հետո ստացված Delivery Status Notifications-ը և աջակցվող բողոքների հաշվետվությունները մշակելու համար։
Bounce-ի պարտադիր դաշտերը
- Bounce Email Domain։
- IMAP Host։
- IMAP Port։
- IMAP Encryption։
- IMAP Username։
- IMAP Password։
Ինչու է այս կապը կարևոր
SMTP փոխանցումից հետո հաղորդագրությունը սկզբում կարող է ստանալ delivered կարգավիճակ, իսկ հետագայում փոխվել soft_bounced-ի կամ hard_bounced-ի, երբ Relay-ն այս mailbox-ից մշակում է DSN-ը։
Feedback loop-ի գրանցում
- Գրանցեք ձեր սեփական ուղարկող դոմենը կամ IP-ն Yahoo/AOL-ի կիրառելի բողոքների ծրագրերում։
- Կիրառելի լինելու դեպքում կարգավորեք Microsoft JMRP-ն։
- Աջակցվող բողոքների հաշվետվություններն ուղղեք նույն կարգավորված bounce mailbox-ին։
- Gmail-ի հեղինակության ամփոփ տվյալների համար առանձին օգտագործեք Google Postmaster Tools-ը։
07. Գրանցեք և հաստատեք Sender Domains-ը
Sender Domains-ը սահմանափակում են, թե ձեր կազմակերպությունը որ դոմենները կարող է օգտագործել հաղորդագրությունների From հասցեներում։
Գրանցեք դոմեն
- Բացեք Relay → Sender Domains բաժինը։
- Ընտրեք Add Domain։
- Մուտքագրեք From հասցեի դոմենային մասը։
- Ստուգեք՝ այն Verified է, թե Unverified։
- Կապվեք Ridgital-ի աջակցության հետ, երբ պահանջվում է հարթակի կողմից իրականացվող հաստատում։
Դոմենի պահանջների կիրառում
Երբ ուղարկողի դոմենի պահանջների կիրառումը միացված է, չգրանցված կամ հեռացված դոմեններ օգտագործող հաղորդագրությունները կարող են մերժվել։
Relay-ում դոմեն գրանցելը չի կարգավորում SPF-ը, DKIM-ը կամ DMARC-ը։ Այս գրառումները կարգավորեք ձեր ելքային էլփոստի ծառայություն մատուցողի միջոցով։
08. Հասկացեք հաղորդագրությունների կարգավիճակները և Email Logs-ը
Relay-ի հետ ինտեգրվելիս օգտագործեք canonicalStatus-ը։ Հաղորդագրության ընդունումը, SMTP փոխանցումը, bounce-ի մշակումը և ստացողի գործողությունները տեղի են ունենում տարբեր ժամանակներում։
submitted և accepted
Relay-ը ստացել և ընդունել է հաղորդագրությունը՝ ասինխրոն մշակման համար։ Առաքումը դեռ չի հաստատվել։
delivered
Կարգավորված Delivery SMTP սերվերն ընդունել է հաղորդագրությունը՝ հետագա երթուղավորման համար։ Դա չի երաշխավորում, որ հաղորդագրությունը կհայտնվի inbox-ում։
deferred և bounced
deferred-ը ներկայացնում է ժամանակավոր ուշացում։ Հետագա bounce մշակումը կարող է առաջացնել soft_bounced կամ hard_bounced կարգավիճակ։
suppressed և failed
Suppression-ը կանխել է առաքումը, կամ հաղորդագրության մշակումը ձախողվել է գրանցված մեկ այլ պատճառով։
Canonical արժեքներ
submitted, accepted, delivered, deferred, hard_bounced, soft_bounced, suppressed և failed։
Ինչ ստուգել Email Logs-ում
- Message ID-ն, Application-ը, ուղարկողը, ստացողը և թեման։
- Ընթացիկ կարգավիճակը և իրադարձությունների ամբողջական ժամանակագրությունը։
- SMTP պատասխանները, սխալները, առաքման փորձերը և կրկնակի փորձերը։
- Bounce-ի, suppression-ի, tracking-ի և webhook-ի գործունեությունը։
09. Կարգավորեք tracking-ը և հասկացեք unsubscribe-ի գործելակերպը
Բացումների և հղումների սեղմումների tracking-ը փաթեթով վերահսկվող գործառույթներ են։ Դրանք միացրեք միայն այն բանից հետո, երբ հասկանաք, թե ինչպես են ազդում հաղորդագրության header-ների և suppression-ների վրա։
trackOpens
Թույլ է տալիս Relay-ին tracking pixel-ի հարցման միջոցով գրանցել հաղորդագրության բացման արդյունքը։
trackClicks
Թույլ է տալիս Relay-ին tracked redirect-ների միջոցով գրանցել աջակցվող հղումների սեղմումների արդյունքները։
Մեկ սեղմումով unsubscribe
trackOpens-ը կամ trackClicks-ը միացնելու դեպքում Relay-ն ավելացնում է List-Unsubscribe և List-Unsubscribe-Post header-ները։ Աջակցվող մեկ սեղմումով unsubscribe-ը ստացողին ավելացնում է ձեր suppression list-ում՝ unsubscribe պատճառաբանությամբ։
Գաղտնիությունը հաշվի առնող tracking
Relay-ը ներգրավվածության իրադարձությունների հետ չի պահպանում ստացողի IP հասցեն, user agent-ը, դիտարկիչը, օպերացիոն համակարգը, սարքի տվյալները, fingerprint-ը, աշխարհագրական դիրքը, ISP-ն, ASN-ը, վարքային պրոֆիլը կամ գովազդային նույնացուցիչը։
Բացումների և հղումների սեղմումների արդյունքները գործառնական ցուցիչներ են։ Caching-ը, պատկերների արգելափակումը, անվտանգության սկաներները, հղումների վերաշարադրումը և ավտոմատացված համակարգերը կարող են ազդել դրանց ճշգրտության վրա։
10. Կառավարեք suppression-ները
Suppression-ը ձեր կազմակերպության ներսում կանխում է տվյալ ստացողին հաղորդագրություն առաքելու հետագա փորձերը։ Suppression-ները չեն ազդում Relay-ի՝ իրար հետ կապ չունեցող այլ հաճախորդների վրա։
Ավտոմատ suppression-ի աղբյուրներ
- Hard bounce։
- Աջակցվող բողոքի հաշվետվություն։
- Մեկ սեղմումով unsubscribe։
- Համապատասխանության գործողություն։
- Հարթակի կողմից սահմանված՝ առաքելիությանը վերաբերող մեկ այլ պայման։
Նախքան suppression-ը հեռացնելը
- Ստուգեք ստացողի հասցեն։
- Ստուգեք suppression-ի պատճառը։
- Ստուգեք՝ երբ և ինչպես է այն ստեղծվել։
- Համոզվեք, որ ստացողին կրկին էլփոստ ուղարկելն օրինական է։
Անկախ պահպանում
Suppression-ները կարող են ակտիվ մնալ նաև դրանց հետ կապված հաղորդագրությունների տվյալների ժամկետի ավարտից հետո։ Compliance-ի միջոցով ստացողի տվյալների ջնջումը չի հեռացնում suppression գրառումը։
11. Կարգավորեք և փորձարկեք webhooks-ը
Ստեղծեք webhook-ը
- Բացեք Relay → Webhooks բաժինը։
- Ընտրեք Add Webhook։
- Մուտքագրեք HTTPS endpoint-ի URL-ը։
- Ընտրեք ձեր Application-ին անհրաժեշտ իրադարձությունները։
- Ցանկության դեպքում ավելացրեք նկարագրություն։
- Անմիջապես պահպանեք ստորագրման secret-ը։
Վավերացրեք payload-ները
Նախքան իրադարձությանը վստահելը կամ այն մշակելը՝ վավերացրեք X-Ridgital-Signature-ում տրամադրված HMAC-SHA256 ստորագրությունը։
Փորձարկեք առաքումը
Օգտագործեք Send Test-ը, ուսումնասիրեք առաքման գրանցված փորձերը և պորտալից կրկնեք այն ձախողված առաքումները, որոնց համար կրկնակի փորձը թույլատրված է։
Փոխեք secret-ը
Rotation-ն անմիջապես անվավեր է դարձնում ստորագրման նախորդ secret-ը։ Փոփոխությունը համաձայնեցրեք ձեր ստացող Application-ի հետ։
Պաշտոնական կարգավիճակ
Webhook-ի առաքումն ասինխրոն է։ Հաղորդագրության գրանցված վիճակի պաշտոնական աղբյուր համարեք Email Logs-ը կամ Relay API-ն։
12. Օգտագործեք համապատասխանության և ստացողի տվյալների գործընթացները
Համապատասխանության գործընթացները հասանելի են կազմակերպության administrator-ներին և կարող են կախված լինել ակտիվ փաթեթից։
Ստացողի որոնում և արտահանում
- Բացեք Relay → Compliance բաժինը։
- Մուտքագրեք մեկ ստացողի էլփոստի հասցե։
- Գտեք դրա հետ կապված Relay գրառումները։
- Ներբեռնեք JSON-ը կամ, երբ հասանելի է, արտահանման հարցում ներկայացրեք։
- Հարցումն ուսումնասիրեք Compliance history-ում։
Ստացողի տվյալների ջնջում
Ջնջումը վերջնականապես հեռացնում է կիրառելի հաղորդագրությունների բովանդակությունը և իրադարձությունների պատմությունը։ Հարցումը կարող է պահանջել աշխատակազմի հաստատումը և ավարտից հետո չի կարող հետ շրջվել։
Ստացողի տվյալների ջնջումը չի հեռացնում ստացողի suppression գրառումը։
Պահպանում
Հաղորդագրությունների բովանդակությունը, metadata-ն, իրադարձությունները, ներգրավվածության տվյալները և webhook log-երը ենթարկվում են փաթեթով սահմանված պահպանման ժամկետներին։ Suppression-ների, audit գրառումների, անվտանգության գրառումների և համապատասխանության գրառումների համար կարող են գործել պահպանման այլ կանոններ։
13. Ստուգեք production-ի ամբողջական կարգավորումը
Հաշիվ և հասանելիություն
- Բաժանորդագրությունն ակտիվ է։
- Օգտատերերի դերերը ճիշտ են։
- Զգայուն հաշիվներն օգտագործում են 2FA։
- Production ռեսուրսներն օգտագործում են նախատեսված Application scope-ը։
Ուղարկում
- Application-ն օգտագործում է ճիշտ API կամ SMTP ingress հավատարմագիրը։
- Secret-ները պահպանվում են անվտանգ եղանակով։
- Չօգտագործվող հավատարմագրերը չեղարկվել են։
GET /relay/ping-ն ընդունում է production API Key-ը։
Առաքում
- Delivery SMTP-ն հաջողությամբ անցնում է Test Connection-ը։
- Ճիշտ կարգավորումն ունի Active և Default կարգավիճակները։
- From Email-ը թույլատրված է։
- Օրական և ժամային սահմանաչափերը ճիշտ են։
- Bounce mailbox-ը հասանելի է։
Մոնիթորինգ
- Իրական փորձնական հաղորդագրությունը ցուցադրվում է Email Logs-ում։
- Հաղորդագրությունը ստանում է ակնկալվող SMTP փոխանցման կարգավիճակը։
- Sender Domains-ը գրանցված են։
- Webhook ստորագրությունները վավերացված են։
- Suppression-ի գործելակերպը հասկանալի է։
14. Ախտորոշեք և շտկեք տարածված խնդիրները
TLS handshake-ի սխալ
Ընտրված port-ն ակնկալում է գաղտնագրման այլ ռեժիմ։ Ստուգեք՝ ծառայություն մատուցողը պահանջում է STARTTLS, թե անմիջական SSL/TLS։
Նույնականացման 535 սխալ
SMTP կամ IMAP սերվերը մերժել է հավատարմագրերը կամ նույնականացման եղանակը։ Ստուգեք օգտանունը, գաղտնաբառի տեսակը և ծառայություն մատուցողի հասանելիության քաղաքականությունը։
Ուղարկողը մերժվել է
Համոզվեք, որ նույնականացված Delivery SMTP հաշիվը կարող է հաղորդագրություններ ուղարկել՝ օգտագործելով կարգավորված From Email-ը և ուղարկողի դոմենը։
Առաքվել է, բայց inbox-ում չկա
Delivered կարգավիճակը հաստատում է SMTP փոխանցումը, ոչ թե inbox-ում հայտնվելը։ Ստուգեք ձեր ծառայություն մատուցողի կարգավորումները, ստացողի զտման կանոնները, ուղարկողի հեղինակությունը և bounce-ի հետագա թարմացումները։
Bounce-ը չի հայտնաբերվել
Ստուգեք Bounce Email Domain-ը, IMAP կարգավորումները, հավատարմագրերը, mailbox-ի երթուղավորումը և feedback loop-ի նպատակակետը։
Հաղորդագրությունը suppressed է
Ուսումնասիրեք suppression-ի պատճառն ու աղբյուրը։ Մի հեռացրեք այն պարզապես bounce-ը, բողոքը, unsubscribe-ը կամ համապատասխանության գործողությունը շրջանցելու համար։
Անվտանգ եղանակով կապվեք աջակցության հետ
Տրամադրեք խնդրահարույց կարգավորման տեսակը, Message ID-ն, ծառայություն մատուցողի անունը և սխալի ճշգրիտ տեքստը։ Երբեք մի ուղարկեք ամբողջական API Keys, SMTP գաղտնաբառեր, SMTP ingress գաղտնաբառեր, IMAP գաղտնաբառեր կամ webhook secret-ներ։