কাস্টমার জার্নি API ওভারভিউ
কাস্টমার জার্নি API একটি ব্যাকএন্ডকে প্রোগ্রাম্যাটিকভাবে কাস্টমার জার্নি পরিচালনা করতে দেয়: জার্নির সংজ্ঞা তৈরি এবং সম্পাদনা করা, জার্নিগুলিকে তাদের জীবনচক্রের (শুরু, বিরতি, শেষ, ড্রাফট, আর্কাইভ) মাধ্যমে সরানো, আপনার নিজের সিস্টেম থেকে একটি চলমান জার্নি ট্রিগার করা, এবং প্রতি-জার্নির পরিসংখ্যান সংগ্রহ করা।
এটি একই API যা কাস্টমার জার্নি বিল্ডার ব্যবহার করে, যা একটি gRPC-Gateway ব্রিজের মাধ্যমে REST/JSON-এর উপর উন্মুক্ত করা হয়েছে।
বেস URL
Anchor link togRPC-Gateway পদ্ধতি এবং লিগ্যাসি এক্সটার্নাল পদ্ধতিগুলি বিভিন্ন হোস্টে পরিবেশন করা হয়:
| পদ্ধতি | বেস URL |
|---|---|
gRPC-Gateway: /api/v3/journeygateway/... (লাইফসাইকেল, তৈরি, আপডেট) | https://journey-api.svc-nue.pushwoosh.com |
লিগ্যাসি এক্সটার্নাল: /api/journey/... (API দ্বারা শুরু, পরিসংখ্যান, ব্যবহারকারী ড্রপ) | https://journey.pushwoosh.com |
অথেন্টিকেশন
Anchor link toপ্রতিটি অনুরোধে একটি Authorization হেডার অন্তর্ভুক্ত করতে হবে যেখানে একটি সার্ভার-সাইড Pushwoosh API অ্যাক্সেস টোকেন থাকবে:
Authorization: Api YOUR_API_TOKENমেথড
Anchor link toজার্নি পরিচালনা করুন
Anchor link to- লাইফসাইকেল:
POST /api/v3/journeygateway/{action}। এর UUID দ্বারা একটি জার্নি শুরু, বিরতি, শেষ, ড্রাফট, বা আর্কাইভ করুন। - তৈরি এবং আপডেট:
POST /api/v3/journeygatewayএবংPUT /api/v3/journeygateway/{uuid}। একটি নতুন জার্নির সংজ্ঞা তৈরি করুন বা একটি বিদ্যমান প্রতিস্থাপন করুন।
জার্নি ট্রিগার করুন
Anchor link to- API দ্বারা শুরু:
POST /api/journey/{id}/start/external। একটি চলমান জার্নির API এন্ট্রি পয়েন্টে ব্যবহারকারীদের ইনজেক্ট করুন।
পরিসংখ্যান এবং অডিয়েন্স
Anchor link to- জার্নির পরিসংখ্যান পান:
GET /api/journey/{id}/statistics/external। প্রতি-পয়েন্ট ডেলিভারি এবং কনভার্সন মেট্রিক্স। - জার্নি থেকে ব্যবহারকারীদের সরান:
POST /api/journey/drop-users/external। সমস্ত বা নির্বাচিত সক্রিয় জার্নি থেকে ব্যবহারকারীদের ড্রপ করুন।
রেফারেন্স
Anchor link to- জার্নি অবজেক্ট: জার্নির সংজ্ঞার আকার (তথ্য, প্যারামিটার, পয়েন্ট, মন্তব্য) যা লাইফসাইকেল, তৈরি এবং আপডেট পদ্ধতি দ্বারা ফেরত দেওয়া হয়।
- পয়েন্ট রেফারেন্স: প্রতিটি পয়েন্ট প্রকারের জন্য
point_dataকাঠামো: এন্ট্রি, টাইমিং, স্প্লিটিং, অ্যাকশন এবং মেসেজিং উপাদান।
লাইফসাইকেল স্টার্ট বনাম স্টার্ট বাই API
Anchor link toকাস্টমার জার্নির দুটি অপারেশন আছে যা শুনতে একই রকম কিন্তু ভিন্নভাবে কাজ করে।
লাইফসাইকেল স্টার্ট জার্নির অবস্থা পরিবর্তন করে (উদাহরণস্বরূপ, ড্রাফট থেকে চলমান)। স্টার্ট বাই API একটি চলমান জার্নিতে ব্যবহারকারীদের ইনজেক্ট করে। নীচের টেবিলটি তাদের পাশাপাশি তুলনা করে।
| লাইফসাইকেল স্টার্ট | স্টার্ট বাই API | |
|---|---|---|
| এন্ডপয়েন্ট | POST /api/v3/journeygateway/start | POST /api/journey/{id}/start/external |
| এটি কী করে | জার্নি সক্রিয় করে এবং এটিকে চলমান অবস্থায় নিয়ে যায় | একটি চলমান জার্নির API এন্ট্রি পয়েন্টে ব্যবহারকারীদের ইনজেক্ট করে |
| জার্নির অবস্থা প্রয়োজন | ড্রাফট বা পজড | চলমান (একটি API স্টার্ট পয়েন্ট সহ) |
| রান ফ্রিকোয়েন্সি | প্রতিবার অবস্থা পরিবর্তনের জন্য একবার | বারবার, যখন ব্যবহারকারীদের প্রবেশ করতে হবে |
রিকোয়েস্ট এবং রেসপন্স ফরম্যাট
Anchor link to- কন্টেন্ট টাইপ:
application/json। v3ফিল্ডের নামsnake_caseব্যবহার করে। Enum মানগুলি তাদের স্ট্রিং নাম হিসাবে সিরিয়ালাইজ করা হয় (উদাহরণস্বরূপ,"STATUS_RUNNING","POINT_TYPE_SEND_PUSH")।- gRPC-Gateway পদ্ধতিগুলি (
/api/v3/journeygateway/...) সফল হলে জার্নি অবজেক্ট এবং ব্যর্থ হলে স্ট্যান্ডার্ড gRPC-Gateway ত্রুটির এনভেলপ ফেরত দেয়:{ "code": ..., "message": ..., "details": [...] }। - লিগ্যাসি এক্সটার্নাল পদ্ধতিগুলি (
/api/journey/...) সফল হলে একটি পদ্ধতি-নির্দিষ্ট JSON বডি এবং বৈধতা ত্রুটির জন্য HTTP400সহ{ "success": false, "message": ... }ফেরত দেয়।
কুইক স্টার্ট
Anchor link tocurl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/start \ -H "Authorization: Api YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'