رفتن به محتوا

پنل Proxynet با مدل سازمانی شبیه GitHub کار می‌کند. یک سازمان سرویس‌ها، موجودی حساب، پلن و توکن‌ها را یک‌جا نگه می‌دارد. اعضای مجاز سازمان در پنل پروکسی می‌سازند و آن را مدیریت می‌کنند؛ API همین کارها را از طریق یک توکن انجام می‌دهد.

آنچه متعلق به سازمان است

سرویس‌ها

همه سفارش‌های پروکسی برای سازمان ثبت می‌شوند. GET /orders سرویس‌های سازمان را فهرست می‌کند.

موجودی حساب و پلن

هزینه سفارش‌ها از موجودی حساب سازمان پرداخت می‌شود؛ قیمت‌ها از پلن سازمان (tier) می‌آیند.

توکن‌های API

توکن در یک سازمان ساخته می‌شود و فقط سرویس‌های همان سازمان را می‌بیند.

فعالیت

هر تغییری که از طریق API انجام شود، در صفحه فعالیت سازمان ثبت می‌شود.

توکن به کدام سازمان تعلق دارد

در پاسخ GET /me، فیلد organization سازمانی را که توکن به آن تعلق دارد نشان می‌دهد و فیلد access می‌گوید این توکن در سازمان چه چیزهایی را می‌تواند ببیند.

GET /me (خلاصه‌شده)
{
  "data": {
    "token": { "name": "سرور پایش", "scopes": ["orders:read"] },
    "organization": { "id": "…", "name": "Stax", "slug": "stax" },
    "access": { "order_visibility": "all", "logs": true },
    "plan": { "name": "Tier 2", "custom_credentials": true },
    "billing": { "balance": 124.5, "currency": "USD" }
  }
}
  • access.order_visibility: توکن کدام‌یک از سرویس‌های سازمان را می‌تواند ببیند. نقطه‌های پایانی فهرست و جزئیات همان قواعد نمایش پنل را اعمال می‌کنند.
  • access.logs: آیا نقطه‌های پایانی لاگ برای این توکن باز هستند. دسترسی به لاگ علاوه بر این مستلزم آن است که پلن، دسترسی به لاگ را شامل شود.

پلن و قیمت

پلن در سطح سازمان تعریف می‌شود. /me، /catalog و /pricing از یک منبع پلن استفاده می‌کنند؛ به همین دلیل، استعلام قیمت با مبلغی که هنگام سفارش کسر می‌شود یکسان است. در سازمانی که پلنی به آن تخصیص داده نشده، پایین‌ترین پلن به کار می‌رود و در پاسخ‌ها price_source: base_plan دیده می‌شود.

plan.custom_credentials نشان می‌دهد که آیا می‌توانید نام کاربری و رمز عبور را در سفارش خودتان انتخاب کنید. اگر اجازه نداشته باشید، درخواستی که این فیلدها را بفرستد403 tier_required برمی‌گرداند؛ اگر آن‌ها را نفرستید، مقادیر به‌طور خودکار ساخته می‌شوند.

چند سازمان

یک کاربر می‌تواند عضو چند سازمان باشد، اما هر توکن فقط به یک سازمان تعلق دارد. برای هر سازمان توکن جداگانه‌ای بسازید و در یکپارچه‌سازی خود، سازمان را با انتخاب توکن مشخص کنید.