ەلەكتروندىق پوشتا ماركەتىينگى قىزمەتتەرىنە ارنالعان API
بۇل API سىرتقى ەلەكتروندىق پوشتا قىزمەتتەرىن ىينتەگراتسىييالاۋ ٴۇشىن ازىرلەنگەن. ول ٴبىر endpoint (مىسالى، https://yourserver.com/planfix_integration.php) ارقىلى تىزىمدەر مەن كونتاكتىلەردى باسقارۋعا مۇمكىندىك بەرەدى جانە سۇراۋلاردى JSON فورماتىندا قابىلدايدى.
ىينتەگراتسىييانى جۇزەگە اسىرعاننان كەيىن، ٴبىزدىڭ Support Service-گە حابارلاسىپ، قىزمەتىڭىزدى Planfix ىينتەرفەيسىندە قولدانۋشىلارعا قولجەتىمدى ىينتەگراتسىييالار تىزىمىنە قوسۋ تۋرالى ٴوتىنىش بەرە الاسىز.
Planfix-پەن قوسىلۋ
- ٴوتىنىشتى قوسۋ جانە باپتاۋ ٴۇشىن ەسەپتىك جازبا باسقارۋ — ىينتەگراتسىييالار — Email marketing بولىمىنە ٴوتىڭىز.
- اشىلعان بولىكتە ٴتىزىمنىڭ سوڭىندا Planfix API تاڭداڭىز.
- ىينتەگراتسىييا باپتاۋلارى تەرەزەسى اشىلادى.
- Planfix سۇراۋلار جىبەرەتىن مەكەنجايدى جانە اۆتورىيزاتسىييا ٴۇشىن API Key كورسەتۋىڭىز كەرەك.
سۇراۋ فورماتى
سۇراۋ POST ٴادىسى ارقىلى ىينتەگراتسىييا باپتاۋلارىندا كورسەتىلگەن مەكەنجايعا JSON فورماتىندا جىبەرىلەدى.
سۇراۋ مىسالى:
{
"action": "action",
"authToken": "your_authorization_token",
"data": {
// Data depending on the action
}
}
سۇراۋ پارامەترلەرى:
| اتى | سىيپاتتاماسى | تىيپ/دەرەكتەر فورماتى | ەسكەرتۋ |
|---|---|---|---|
| action | ورىنداۋعا ٴتىيىس ارەكەت | string | |
| authToken | API-عا رۇقسات الۋ ٴۇشىن اۆتورىيزاتسىييا توكەنى | string | |
| data | ارەكەتكە بايلانىستى دەرەكتەر | object |
قولدانىلاتىن ارەكەتتەر
- createList — تاراتۋ ٴتىزىمىن قۇرۋ
- deleteList — تاراتۋ ٴتىزىمىن جويۋ
- importContacts — كونتاكتىلەردى تىزىمگە ىيمپورتتاۋ
- updateContact — كونتاكتىنى جاڭارتۋ
createList — تاراتۋ ٴتىزىمىن قۇرۋ
سىيپاتتاما: كورسەتىلگەن اتاۋمەن جاڭا تاراتۋ ٴتىزىمىن قۇرادى.
سۇراۋ:
{
"action": "createList",
"authToken": "your_authorization_token",
"data": {
"listName": "List name"
}
}
'جاۋاپ (ٴساتتى):
{
"success": true,
"listId": "unique_list_identifier""
}
جاۋاپ (قاتە):
{
"error": "Error description"
}
deleteList — تاراتۋ ٴتىزىمىن جويۋ
سىيپاتتاما: تاراتۋ ٴتىزىمىن ونىڭ ىيدەنتىيفىيكاتورى بويىنشا جويادى.
سۇراۋ:
{
"action": "deleteList",
"authToken": "your_authorization_token",
"data": {
"listId": "list_identifier"
}
}
جاۋاپ (ٴساتتى):
{
"success": true
}
جاۋاپ (قاتە):
{
"error": "Error description"
}
importContacts — كونتاكتىلەردى تىزىمگە ىيمپورتتاۋ
سىيپاتتاما: بەلگىلەنگەن تاراتۋ تىزىمىنە كونتاكتىلەردى ىيمپورتتايدى.
سۇراۋ:
{
"action": "importContacts",
"authToken": "your_authorization_token",
"data": {
"listId": "list_identifier",
"contacts": [
{
"id": 123,
"email": "email@example.com",
"firstName": "Name",
"lastName": "Last name"
}
]
}
}
جاۋاپ (ٴساتتى):
{
"success": true
}
جاۋاپ (قاتە):
{
"error": "Error description"
}
updateContact — كونتاكتىنى جاڭارتۋ
سىيپاتتاما: تاراتۋ تىزىمىندەگى كونتاكتىنى جاڭارتادى. قولدايتىن ارەكەتتەر: add، update، delete.
سۇراۋ:
{
"action": "updateContact",
"authToken": "your_authorization_token",
"data": {
"listId": "list_identifier",
"action": "add|update|delete",
"contact": {
"id": 123,
"email": "email@example.com",
"firstName": "First name",
"lastName": "Last name"
},
"oldEmail": "old_email@example.com" // only for action=update
}
}
جاۋاپ (ٴساتتى):
{
"success": true
}
جاۋاپ (قاتە):
{
"error": "Error description"
}
ماڭىزدى
- بارلىق سۇراۋلار JSON فورماتىندا جاۋاپ قايتارۋى ٴتىيىس.
- قاتە بولعان جاعدايدا ارقاشان "error" ورىسىندە قاتە سىيپاتتاماسى كورسەتىلۋى ٴتىيىس.
- ساتتىلىك بولعان جاعدايدا ارقاشان "success": true ٴورىسى بولۋى ٴتىيىس.
- اۆتورىيزاتسىييا ٴار سۇراۋداعى "authToken" ٴورىسى ارقىلى جۇزەگە اسادى.
- بارلىق ماتىندىك ورىستەر UTF-۸ كودتاۋىندا بولۋى ٴتىيىس.