VPS.org API

REST API ডকুমেন্টেশন

অ্যাকাউন্ট API

অ্যাকাউন্ট প্রোফাইল এবং API টোকেন সংক্রান্ত তথ্য উদ্ধার করুন। কোন অ্যাকাউন্ট এবং অনুমতি একটি API টোকেনের সাথে সংযুক্ত তা নির্ধারণের জন্য এটি ব্যবহার করা যেতে পারে।

শেষবিন্দু ১টি সমাপ্তিবিন্দু
বেস পাথ /api/v1/account
পান /api/v1/account/me/

অ্যাকাউন্ট & টোকেন তথ্য প্রাপ্ত করো

অনুরোধের মধ্যে ব্যবহৃত API টোকেনের জন্য অ্যাকাউন্ট প্রোফাইল মেটাডাটা এবং টোকেন পরিধি/অনুমতি ফিরিয়ে আনে। এটি ব্যবহার করা যেতে পারে যখন আপনি একাধিক API টোকেন পরিচালনা করেন এবং কোন অ্যাকাউন্টের একটি টোকেন এবং এর অনুমতি সনাক্ত করার প্রয়োজন হয়।

প্রমাণীকরণ

বৈধ API টোকেন আবশ্যক। যেকোন সক্রিয় টোকেন এই এনডপয়েন্ট ব্যবহার করতে পারে, তার অনুমতির পরিধির উপর নির্ভর না করে।

উদাহরণ অনুরোধ

cURL
Python
JavaScript
PHP
curl -X GET "https://admin.vps.org/api/v1/account/me/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/account/me/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()

print(f"Account: {data['account']['email']}")
print(f"Token: {data['token']['name']}")
print(f"Permissions: {data['token']['permissions']}")
const response = await fetch('https://admin.vps.org/api/v1/account/me/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(`Account: ${data.account.email}`);
console.log(`Token: ${data.token.name}`);
console.log(`Permissions:`, data.token.permissions);
$ch = curl_init('https://admin.vps.org/api/v1/account/me/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

echo "Account: " . $data['account']['email'] . "\n";
echo "Token: " . $data['token']['name'] . "\n";
echo "Permissions: " . implode(', ', $data['token']['permissions']) . "\n";

উদাহরণ প্রতিক্রিয়া

{
  "account": {
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "company_name": "Acme Inc.",
    "created_at": "2024-06-15"
  },
  "token": {
    "name": "Production Deploy Key",
    "permissions": [
      "servers:list",
      "servers:create",
      "servers:power",
      "dns:*"
    ],
    "created_at": "2025-01-10T14:30:00Z",
    "last_used_at": "2025-02-11T08:45:12Z",
    "expires_at": null,
    "is_expired": false
  }
}

প্রতিক্রিয়া ক্ষেত্র

account object
ক্ষেত্র আদর্শ বর্ণনা
email string Account email address
first_name string | null Account holder's first name
last_name string | null Account holder's last name
company_name string | null Company name (if set)
created_at date Account creation date (YYYY-MM-DD)
token object
ক্ষেত্র আদর্শ বর্ণনা
name string Name assigned to this API token
permissions array List of permission strings (e.g. servers:list, dns:*). See Authentication docs for permission format.
created_at datetime When the token was created (ISO 8601)
last_used_at datetime | null Last time the token was used for authentication
expires_at datetime | null Token expiration date (null if no expiration)
is_expired boolean Whether the token has expired

উত্তরের অবস্থার কোড

200 Successfully retrieved account and token information
401 Unauthorized - Invalid, expired, or missing API token

সাধারণ ব্যবহারের ক্ষেত্রে

ট্যাব সনাক্ত করো

বিভিন্ন অ্যাপ্লিকেশনের মধ্যে একাধিক API টোকেন পরিচালনা করার সময়, একটি টোকেন কোন অ্যাকাউন্টের অন্তর্গত তা পরীক্ষা করতে এই এনডপোইন্ট ব্যবহার করুন:

# Check which account this token is associated with
response = requests.get(
    "https://admin.vps.org/api/v1/account/me/",
    headers={"Authorization": f"Bearer {api_token}"}
)
account = response.json()["account"]
print(f"This token belongs to: {account['email']}")

টোকেন অনুমতি পরীক্ষা করো

API কল করার পূর্বে, বর্তমান টোকেনের জন্য কোন অনুমতি আছে তা পরীক্ষা করুন:

# Check token permissions before performing an action
response = requests.get(
    "https://admin.vps.org/api/v1/account/me/",
    headers={"Authorization": f"Bearer {api_token}"}
)
permissions = response.json()["token"]["permissions"]

if "servers:create" in permissions or "servers:*" in permissions:
    # Token has permission to create servers
    create_server()
else:
    print("Token does not have servers:create permission")

টোকেন- এর মেয়াদ উত্তীর্ণ হওয়া পর্যবেক্ষণ করো

আপনার টোকেনের মেয়াদ শেষ হওয়ার উপক্রম হয়েছে কিনা তা পরীক্ষা করুন:

from datetime import datetime

response = requests.get(
    "https://admin.vps.org/api/v1/account/me/",
    headers={"Authorization": f"Bearer {api_token}"}
)
token_info = response.json()["token"]

if token_info["expires_at"]:
    expires = datetime.fromisoformat(token_info["expires_at"])
    days_left = (expires - datetime.now()).days
    if days_left < 7:
        print(f"Warning: Token expires in {days_left} days")
else:
    print("Token has no expiration date")

অনুমতি সংক্রান্ত রেফারেন্স

অনুমতি ফরম্যাট অনুসরণ করে resource:action. ব্যবহার resource:* একটি রিসোর্সের জন্য সম্পূর্ণ ব্যবহারের জন্য, অথবা *:* সম্পূর্ণ API ব্যবহারের জন্য।

রিসোর্স ব্যবহারযোগ্য কাজ
servers list, create, update, delete, power, backup, snapshot, resize, *
domains list, search, update, renew, *
dns list, create, update, delete, *
snapshots list, delete, *
backups list, *
ssh-keys list, create, delete, *
plans list, *
locations list, *
deployments list, create, delete, *
billing list, *
Manage your tokens: Create, edit, and revoke API tokens at admin.vps.org/account/developers/