API রেফারেন্স
প্রমাণীকরণ
API কী শিরোনাম, গোপন ব্যবস্থাপনা, অনুমতি এবং ঘূর্ণন।
শংসাপত্রের মডেল
MakePay API কীগুলি MakeCrypto ডেভেলপার এলাকা থেকে তৈরি করা হয়েছে এবং একটি দলে স্কোপ করা হয়েছে৷ প্রতিটি কীর একটি পাবলিক কী আইডি এবং একটি গোপনীয়তা রয়েছে। গোপন একটি হ্যাশ হিসাবে সংরক্ষণ করা হয় এবং সৃষ্টির পরে শুধুমাত্র একবার দেখানো হয়.
| Header | Value | Notes |
|---|---|---|
x-makecrypto-key-id | MakePay API key ID | MakePay payment APIs-এর জন্য mk_makepay_ দিয়ে শুরু হয়. |
x-makecrypto-key-secret | One-time API secret | শুধু key তৈরি করার সময় দেখানো হয়. এটি server-side secret manager-এ সংরক্ষণ করুন. |
API কী সৃষ্টি
settings.manage অনুমতি সহ সাইন-ইন করা ব্যবহারকারীরা পোর্টালের মাধ্যমে বা টিম ইন্টিগ্রেশন রুটের মাধ্যমে কী তৈরি করতে পারেন।
সাইন-ইন করা কোম্পানি আবিষ্কার রুট ব্যবহার করুন যখন একটি পোর্টাল টুল বর্তমান ব্যবহারকারীর কাছে উপলব্ধ দলগুলি দেখাতে হবে:
GET /api/partner/v1/companies
ফিরে আসা কোম্পানি id শুধুমাত্র ড্যাশবোর্ড/কী-ম্যানেজমেন্ট রুটের জন্য ব্যবহার করা হয়। MakePay সার্ভার-টু-সার্ভার পেমেন্ট রুটগুলি API কী থেকে কোম্পানির সমাধান করে, তাই তাদের URL-এ কোম্পানির আইডির প্রয়োজন হয় না।
POST /api/partner/v1/companies/{companyId}/integrations
Content-Type: application/json
{
"name": "Production backend",
"appSlug": "makepay",
"allowedOrigins": ["https://merchant.example"]
}
প্রতিক্রিয়া integration.key_id, integration.partner_id, এবং integration.keySecret অন্তর্ভুক্ত। keySecret অবিলম্বে সংরক্ষণ করুন।
প্রমাণীকরণের অনুরোধ করুন
MakePay পেমেন্ট-লিঙ্ক রুটে হেডার হিসেবে কী আইডি এবং গোপনীয়তা পাঠান।
x-makecrypto-key-id: mk_makepay_...
x-makecrypto-key-secret: mksec_...
API পোর্টাল UI কলগুলির জন্য সাইন-ইন MakeCrypto ব্রাউজার সেশনগুলিও গ্রহণ করে৷ সার্ভার-টু-সার্ভার ইন্টিগ্রেশনে মূল শিরোনাম ব্যবহার করা উচিত যাতে অনুরোধগুলি ব্যবহারকারীর সেশন থেকে স্বাধীন হয়।
অনুমতি
রিড রুটগুলি যেকোন সাইন ইন করা দলের সদস্য বা একটি বৈধ MakePay API কী গ্রহণ করে৷ ব্রাউজার সেশনের জন্য রূপান্তরিত রুটগুলির জন্য settings.manage প্রয়োজন৷ API কীগুলি মালিকানাধীন দলের জন্য বিশ্বস্ত সার্ভারের শংসাপত্র হিসাবে বিবেচিত হয়, তাই আপনার নিয়ন্ত্রণ করা ব্যাকএন্ড সিস্টেমগুলিতে সীমাবদ্ধ রাখুন৷
ঘূর্ণন এবং প্রত্যাহার
একটি নতুন কী তৈরি করুন, এটি আপনার ব্যাকএন্ডে স্থাপন করুন, তারপর MakeCrypto বিকাশকারী এলাকায় পুরানো কীটি নিষ্ক্রিয় করুন বা মুছুন৷ সৃষ্টির পর বিদ্যমান রহস্য আর প্রকাশ করা যায় না।
প্রমাণীকরণ ত্রুটি
401 Unauthorizedমানে অনুরোধটির কোন বৈধ সেশন নেই এবং কোন বৈধ API কী জোড়া নেই।401 Invalid MakePay API credentialsমানে কী আইডি, গোপনীয়তা, পণ্যের সুযোগ, বা সক্রিয় অবস্থা মেলেনি।403 Forbiddenমানে সাইন-ইন করা ব্যবহারকারী দলে প্রবেশ করতে পারে না বা প্রয়োজনীয় অনুমতির অভাব রয়েছে।404 API key not foundকী-ব্যবস্থাপনা রুট দ্বারা ফেরত দেওয়া হয় যখন নির্বাচিতpartnerIdদলের জন্য বিদ্যমান না থাকে।