VF ভার্টফিউশন বাংলা ডকুমেন্টেশন
English

ফেজ ৫ — API ও ইন্টিগ্রেশন#

৯টি লেসন · লেভেল: মধ্যম থেকে উন্নত

প্যানেলে যা যা করা যায়, প্রায় সবই API দিয়ে করা যায়। বিলিং সিস্টেম, নিজের অ্যাপ বা অটোমেশন স্ক্রিপ্ট — সব এখান থেকেই VirtFusion-এর সাথে কথা বলে।

এই ফেজের পাথগুলো বাস্তব ইন্টিগ্রেশনে যাচাই করা। তবে প্রতিটি এন্ডপয়েন্টের পূর্ণ রিকোয়েস্ট ফিল্ড ও রেসপন্স কাঠামো আপনার প্যানেলের সংস্করণ অনুযায়ী বদলায় — নিজের কন্ট্রোল সার্ভারের API রেফারেন্স মিলিয়ে নিন।

এই ফেজে কী আছে#

লেসনকী শিখবেন
১ — টোকেন, বেস URL ও অনুরোধের গঠনটোকেন বানানো ও এরর কোড পড়া
২ — ইউজার ও SSO টোকেনbyExtRelation দিয়ে ইউজার খোঁজা ও পাসওয়ার্ড ছাড়া লগইন
৩ — সার্ভার তৈরি ও বিল্ডcreate ও build কলের পূর্ণ প্রবাহ
৪ — সার্ভার নিয়ন্ত্রণ ও পরিবর্তনপাওয়ার, রিসাইজ, IP ও পাসওয়ার্ডের কল
৫ — ইনভেন্টরি: হাইপারভাইজার, প্যাকেজ, IPকোথায় কতটা জায়গা খালি তা জানা
৬ — SSH কী ব্যবস্থাপনাবিল্ডের সময় কী বসানোর জন্য
৭ — Webhook ও Event Hookকোনো ঘটনা ঘটলে আপনার সিস্টেমকে জানানো
৮ — বিলিং ইন্টিগ্রেশনWHMCS সহ সাতটি সিস্টেমের মডিউল
৯ — নিজের প্যানেল বা অটোমেশন বানানোVirtFusion-কে ইঞ্জিন রেখে নিজের UI

লেসন ১ — টোকেন, বেস URL ও অনুরোধের গঠন#

টোকেন তৈরি#

প্যানেলে System → API → Create Token। টোকেনকে নির্দিষ্ট IP-তে সীমাবদ্ধ করা যায় — প্রোডাকশনে অবশ্যই করবেন।

নিরাপত্তা: টোকেন পেলে যে কেউ পুরো প্যানেল চালাতে পারবে। এটি গিটে রাখবেন না, লগে লিখবেন না। আপনার অ্যাপের আউটবাউন্ড IP স্থির রাখুন, তারপর টোকেন সেই IP-তে লক করুন।

অনুরোধের গঠন#

HTTP
POST /api/v1/servers HTTP/1.1
Host: panel.example.com
Authorization: Bearer <API_TOKEN>
Content-Type: application/json
Accept: application/json
বিষয়মান
বেস URLhttps://<কন্ট্রোল-সার্ভার>/api/v1
অথAuthorization: Bearer <token>
ফরম্যাটJSON (Accept: application/json পাঠান)
সংযোগ পরীক্ষাGET /connect

এরর সামলানো#

স্ট্যাটাসমানেকরণীয়
401টোকেন ভুল বা IP মেলেনিটোকেন ও IP লক যাচাই করুন
403অনুমতি নেইটোকেনের স্কোপ দেখুন
422ভ্যালিডেশন ব্যর্থরেসপন্সের errors পড়ুন
429রেট লিমিটRetry-After মেনে অপেক্ষা করে আবার চেষ্টা
5xxপ্যানেলের সমস্যাব্যাকঅফসহ পুনরায় চেষ্টা

৭.x সংস্করণে প্রতি-ইউজার রেট লিমিট বসানো যায়, তাই ক্লায়েন্টে exponential backoff রাখুন। টাইমআউট ১৫ সেকেন্ডের মতো যুক্তিসংগত, কারণ কিছু কল হাইপারভাইজার পর্যন্ত যায়।


লেসন ২ — ইউজার ও SSO টোকেন#

ইউজার তৈরি ও খোঁজা#

HTTP
POST /api/v1/users
GET  /api/v1/users/{extRelationId}/byExtRelation

byExtRelation দিয়ে নিজের সিস্টেমের ইউজার আইডি ধরে VirtFusion ইউজার খুঁজে পাওয়া যায়। নিজের ডাটাবেসে VirtFusion-এর ভেতরের আইডি প্রাইমারি কী করবেন না।

SSO — কাস্টমারকে প্যানেলে ঢোকানো#

কাস্টমার আপনার সাইটে লগইন করা অবস্থায় "Open console" চাপলে তাকে পাসওয়ার্ড ছাড়াই VirtFusion-এ ঢোকানো যায়:

HTTP
POST /api/v1/users/{userId}/authenticationTokens
POST /api/v1/users/{userId}/serverAuthenticationTokens/{serverId}
  • প্রথমটি প্যানেলে সাধারণ লগইনের টোকেন দেয়
  • দ্বিতীয়টি সরাসরি নির্দিষ্ট সার্ভারের পাতায় নিয়ে যায়

টোকেন স্বল্পস্থায়ী — তৈরি করেই সাথে সাথে রিডাইরেক্ট করুন, সংরক্ষণ করবেন না।

সতর্কতা: SSO টোকেন অ্যাডমিন অ্যাকাউন্টের জন্য নয়। কাস্টমারের ইউজার আইডি ব্যবহার করুন, নইলে "Oops! Something went wrong" আসবে।


লেসন ৩ — সার্ভার তৈরি ও বিল্ড#

দুই ধাপের প্রবাহ#

CODE
POST /api/v1/servers          → সার্ভার রেকর্ড, রিসোর্স ও IP বরাদ্দ
POST /api/v1/servers/{id}/build → OS বসে, cloud-init চলে, VM চালু হয়

তৈরির সময় সাধারণত যা পাঠাতে হয়: হাইপারভাইজার গ্রুপ আইডি, প্যাকেজ আইডি, ইউজার আইডি, IPv4 সংখ্যা। বিল্ডের সময়: টেমপ্লেট আইডি, হোস্টনেম, পাসওয়ার্ড বা SSH কী।

কিউ পোলিং#

ভারী কাজগুলো সিঙ্ক্রোনাস নয় — একটি job আইডি ফেরত আসে:

HTTP
GET /api/v1/queue/{jobId}

নকশার নিয়ম: বিল্ড শেষ হয়েছে ধরে নেবেন না। কিউ পোল করুন, অথবা সার্ভারের অবস্থা (GET /servers/{id}) দেখে নিশ্চিত হোন যে state ঠিক আছে এবং IPv4 বসেছে।

একটি বাস্তব ক্রম#

  1. কাস্টমার অর্ডার করল
  2. byExtRelation দিয়ে ইউজার খুঁজুন, না থাকলে POST /users
  3. POST /servers — সার্ভার তৈরি
  4. POST /servers/{id}/build — OS বসানো
  5. GET /queue/{jobId} পোল করুন
  6. state = ready এবং IPv4 আছে → কাস্টমারকে তথ্য পাঠান

লেসন ৪ — সার্ভার নিয়ন্ত্রণ ও পরিবর্তন#

পাওয়ার#

HTTP
POST /api/v1/servers/{id}/power/{action}

{action}: boot, shutdown, restart, poweroff (আপনার সংস্করণের রেফারেন্স মিলিয়ে নিন)।

রিসোর্স বদল#

HTTP
POST /api/v1/servers/{id}/modify/cpuCores
POST /api/v1/servers/{id}/modify/memory
POST /api/v1/servers/{id}/modify/cpuThrottle
POST /api/v1/servers/{id}/modify/traffic

আপগ্রেড/ডাউনগ্রেডে প্রতিটি আলাদা কল — একসাথে সব পাঠানোর চেষ্টা করবেন না।

IP ব্যবস্থাপনা#

HTTP
GET    /api/v1/servers/{id}/ipv4        # বর্তমান IP তালিকা
POST   /api/v1/servers/{id}/ipv4Qty     # কতটি IPv4 থাকবে, বাড়ানো/কমানো

অন্যান্য#

কাজএন্ডপয়েন্ট
root পাসওয়ার্ড রিসেটPOST /servers/{id}/resetPassword
ট্রাফিক হিসাবGET /servers/{id}/traffic
সাসপেন্ডPOST /servers/{id}/suspend
আনসাসপেন্ডPOST /servers/{id}/unsuspend
VNC চালু/তথ্যPOST /servers/{id}/vnc
সার্ভার তথ্যGET /servers/{id}
সার্ভার ডিলিটDELETE /servers/{id} (delay প্যারামিটার সমর্থিত)

সতর্কতা: ডিলিট অপরিবর্তনীয় — ডিস্ক ও IP ফেরত চলে যায়। নিজের অ্যাপে দুই ধাপের নিশ্চিতকরণ রাখুন, আর গুরুত্বপূর্ণ সার্ভারে vfcli-ctrl server:dnd enable ব্যবহার করুন।


লেসন ৫ — ইনভেন্টরি: হাইপারভাইজার, প্যাকেজ, IP#

এন্ডপয়েন্ট#

HTTP
GET /api/v1/compute/hypervisors
GET /api/v1/compute/hypervisors/groups
GET /api/v1/compute/hypervisors/groups/{groupId}/resources
GET /api/v1/packages
GET /api/v1/connectivity/ipblocks

ক্যাপাসিটি যাচাই — বিক্রির আগে#

groups/{id}/resources দিয়ে জানা যায় ওই গ্রুপে আর কত জায়গা আছে। অর্ডার নেওয়ার আগেই এটি দেখে নেওয়া ভালো, নইলে টাকা নিয়ে বিল্ড ব্যর্থ হবে।

বাস্তব নকশায় দুইটি সুরক্ষা রাখুন:

  1. ওভারকমিট অনুপাত — vCPU-তে ৩:১ বা ৪:১ চললেও RAM-এ সাধারণত ১:১
  2. রিজার্ভড হেডরুম — নোডের ১০–১৫% ফাঁকা রাখুন, রিবুট ও মাইগ্রেশনের জন্য

একাধিক অঞ্চল#

একাধিক লোকেশন থাকলে প্রতি অঞ্চলে আলাদা কন্ট্রোল সার্ভার হতে পারে। তখন নিজের অ্যাপে প্রতি অঞ্চলের জন্য আলাদা বেস URL ও টোকেন রাখুন, এবং সার্ভার কোন প্যানেলের — সেটি ডাটাবেসে লিখে রাখুন। ভুল প্যানেলে জিজ্ঞাসা করলে "not found" আসবে।


লেসন ৬ — SSH কী ব্যবস্থাপনা#

HTTP
GET    /api/v1/ssh_keys
POST   /api/v1/ssh_keys
GET    /api/v1/ssh_keys/user/{userId}
DELETE /api/v1/ssh_keys/{keyId}

কাস্টমারের কী আগে থেকে বসিয়ে রাখলে বিল্ডের সময় সেটি VM-এ চলে যায় — পাসওয়ার্ড ইমেইলে পাঠানোর দরকার পড়ে না। এটিই নিরাপদ অভ্যাস।


লেসন ৭ — Webhook ও Event Hook#

Webhook#

VirtFusion কোনো ঘটনা ঘটলে আপনার URL-এ HTTP POST পাঠায়।

হেডারকী থাকে
X-VirtFusion-Hookwebhook আইডি
X-VirtFusion-Eventঘটনার নাম, যেমন server.create
X-VirtFusion-Event-Statussuccess / fail / any
X-VirtFusion-CreatedISO8601 সময়

পেলোড JSON — মূল তথ্য থাকে data-তে, সাথে event, hookId, eventStatus ও কন্ট্রোল ডোমেইনের তথ্য।

অথেন্টিকেশন: ঐচ্ছিক bearer টোকেন সমর্থিত; টোকেন সবসময় base64 এনকোড হয়ে Authorization হেডারে যায়।

ঘটনার সংখ্যা: ৩৫টির বেশি, চার ভাগে —

ভাগউদাহরণ
Serverতৈরি, ডিলিট, পাওয়ার, মাইগ্রেশন, IP বরাদ্দ
Userইউজার তৈরি, পরিবর্তন, ডিলিট
Systemব্যাকআপ, হাইপারভাইজার মনিটরিং, মেইলআউট
Catch-allআইডি 1000 — সব ঘটনা

নকশার নিয়ম#

  • এন্ডপয়েন্ট আইডেমপোটেন্ট রাখুন — একই ঘটনা দুইবার এলেও ক্ষতি না হয়
  • দ্রুত 200 ফেরত দিন, ভারী কাজ নিজের কিউতে ফেলুন
  • টোকেন যাচাই করুন, নাহলে যে কেউ ভুয়া ইভেন্ট পাঠাতে পারবে

Slack, Discord, Google Chat, Pushover ও Telegram-এ পাঠানোর জন্য VirtFusion-এর webhook proxy অ্যাপ আছে।

Event Hook#

Webhook বাইরে বার্তা পাঠায়; event hook ঘটনার সময় নিজস্ব কোড/অ্যাকশন চালায় (হাইপারভাইজার-স্তরের হুকসহ)। যেখানে বাইরের সিস্টেমকে জানানো নয়, বরং ভেতরে কিছু করাতে হবে — সেখানে এটি ব্যবহার করুন।


লেসন ৮ — বিলিং ইন্টিগ্রেশন#

কোনটি কী#

সিস্টেমমডিউল কে বানায়মন্তব্য
WHMCSVirtFusionসবচেয়ে বেশি ব্যবহৃত, direct login bridge সহ
WHMCS Resource PacksVirtFusionসার্ভার নয়, রিসোর্স প্যাক বিক্রির জন্য
BlestaVirtFusionlogin bridge সহ
ClientexecVirtFusionlogin bridge সহ
BillingServVirtFusionlogin bridge সহ
HostBillHostBill টিমতৃতীয় পক্ষ
PaymenterPaymenter টিমতৃতীয় পক্ষ
UpmindUpmind টিমতৃতীয় পক্ষ

প্রায় সব মডিউলই চারটি কাজ করে: create, suspend, unsuspend, terminate।

WHMCS সেটআপ — ধাপে ধাপে#

  1. মডিউল নামিয়ে WHMCS-এর রুটে extract করুন (২.৫ সংস্করণে VirtFusion v6.0+ লাগে)
  2. VirtFusion-এ System → API → Create Token — চাইলে IP-তে সীমাবদ্ধ করুন
  3. WHMCS-এ Servers → Add — মডিউল "VirtFusion Direct Provisioning",

টোকেনটি password ঘরে বসান

  1. সার্ভার গ্রুপ ও প্রোডাক্ট গ্রুপ বানান
  2. প্রোডাক্টে Hypervisor Group IDPackage ID বসান (VirtFusion থেকে নেওয়া)

কনফিগারেবল অপশন#

প্যাকেজের ডিফল্ট ওভাররাইড করা যায় — IPv4 সংখ্যা, স্টোরেজ, মেমরি, ব্যান্ডউইথ, CPU কোর, নেটওয়ার্ক ও স্টোরেজ প্রোফাইল। নাম হুবহু মিলতে হবে, নয়তো ConfigOptionMapping.php-এ ম্যাপ করে দিতে হবে।

একাধিক WHMCS#

একই কন্ট্রোল সার্ভারে একাধিক WHMCS চললে MultiInstance.php চালু করে প্রতিটির জন্য ১–৫ অক্ষরের আলাদা প্রিফিক্স দিন — নইলে ক্লায়েন্ট আইডি সংঘর্ষ করবে।


লেসন ৯ — নিজের প্যানেল বা অটোমেশন বানানো#

কেন নিজের স্তর#

অনেক প্রোভাইডার VirtFusion-কে ইঞ্জিন হিসেবে রেখে নিজের UI বানায় — নিজের ব্র্যান্ড, নিজের চেকআউট, নিজের ভাষা।

হাইব্রিড নকশা — সবচেয়ে বাস্তবসম্মত#

কাজকোথায়
অর্ডার, চেকআউট, ইনভয়েসআপনার অ্যাপে
পাওয়ার, রিবিল্ড, পাসওয়ার্ড রিসেট, ট্রাফিক, IPআপনার অ্যাপে (API দিয়ে)
VNC কনসোল, ফায়ারওয়াল, ব্যাকআপ UISSO দিয়ে VirtFusion প্যানেলে পাঠান

সবকিছু নিজে বানানোর চেষ্টা করলে কনসোল ও ব্যাকআপের UI নকল করতে গিয়ে সময় নষ্ট হবে।

কোড সাজানোর নিয়ম#

একটি পাতলা ক্লায়েন্ট স্তর রাখুন, যেখানে থাকবে: retry, backoff, এরর ম্যাপিং, আর লগে টোকেন গোপন রাখা। বাকি অ্যাপ যেন VirtFusion-এর মাঠের নাম না জানে — তাহলে পরে অন্য ব্যাকএন্ড (যেমন Proxmox) যোগ করা সহজ হয়।

CODE
আপনার অ্যাপ
   │  ServerProvider (ইন্টারফেস)
   ▼
VirtFusionDriver ──▶ VirtFusionClient ──▶ /api/v1
                          │
                    retry / backoff / redacted log

যে ভুলগুলো সবচেয়ে বেশি হয়#

  1. বিল্ড সিঙ্ক্রোনাস ধরে নেওয়া — কিউ পোল করুন
  2. VirtFusion-এর ইউজার আইডি প্রাইমারি কী করাextRelationId ব্যবহার করুন
  3. রেট লিমিট উপেক্ষা — 429 হ্যান্ডল করুন
  4. টোকেন IP-তে লক না করা — টোকেন ফাঁস হলে পুরো প্যানেল খোলা
  5. ক্যাপাসিটি না দেখে অর্ডার নেওয়া — বিল্ড ব্যর্থ হবে, রিফান্ড দিতে হবে

ফেজ ৫ শেষে আপনি যা পারবেন#

  • টোকেন বানিয়ে নিরাপদে API কল করা
  • ইউজার ম্যাপিং ও SSO লগইন বসানো
  • সার্ভার তৈরি → বিল্ড → কিউ পোলিং প্রবাহ লেখা
  • পাওয়ার, রিসাইজ, IP ও পাসওয়ার্ড API চালানো
  • ক্যাপাসিটি দেখে অর্ডার গ্রহণ করা
  • webhook গ্রহণ ও যাচাই করা
  • WHMCS বা নিজের প্যানেল যুক্ত করা

পরবর্তী: ফেজ ৬ — কাস্টমার প্যানেল