nsin- مستندات
- API و MCP
کلیدهای API
مدیریت API key برای دسترسی برنامه‌نویسی به domain، DNS، cache و analytics.
در این صفحه
API keyها به script، CI و ابزارهای AI اجازه می‌دهند به جای شما API را صدا بزنند — با domainهای شما، domainهای shareشده، و نقش‌های پنل.
ساخت یک key
- پنل را باز کنید، avatar → Settings → API keys.
- روی Create key بزنید، برایش اسم بگذارید (مثلاً
CI deploy). - تاریخ انقضا را انتخاب کنید (never / 30 / 90 / 365 روز)، read-only یا نه.
- همین الان key را کپی کنید.
فرمت:
nsin_a1b2c3d4e5f6… (69 کاراکتر)دسترسی کامل در برابر read-only
| حالت | چه کاری می‌تواند بکند |
|---|---|
| Full access | هر کاری که account شما می‌تواند بکند — record، rule، cache، SSL. |
| Read-only | هر GET، به‌علاوه POST /analytics/query (sandboxed: یک SELECT روی logهای شما). بدون write. |
نقش‌های domain اعمال می‌شود — یک Viewer shareشده حتی با full access هم نمی‌تواند record را edit کند.
Authenticate کردن request
هر دو header کار می‌کند — کلاینت‌های MCP از Authorization: Bearer استفاده می‌کنند:
curl -H "Authorization: Bearer nsin_your_key_here" https://api.nsin.ir/domains/
curl -H "X-Api-Key: nsin_your_key_here" https://api.nsin.ir/domains/محدودیت‌ها
- Rate limit: هر key، 300 request در دقیقه؛ بیشتر از آن،
429. - مسدود: account (
/users/…)، billing (/billing/…)، admin، auth — نمی‌توانید key بسازید یا revoke کنید. - سقف: 10 key فعال برای هر account.
استفاده و revoke
تب API keys: زمان آخرین استفاده، chart 30 روزه. Revoke فوری است — 401 روی requestهای در حال اجرا و آینده.