مرجع متدهای API نماینده
همهٔ نقاط پایانی API نماینده فروش OneProvider در یک جدول، هر کدام با دامنه و پرچم idempotency، بهعلاوهٔ پیوند مشخصات OpenAPI 3.1، آمادهٔ درونریزی.
همهٔ متدهای API نماینده فروش در یک جدول، با دسترسی و پرچم Idempotency هر کدام، و پیوند به مشخصات OpenAPI 3.1.
همهٔ مدلها، قابلیتها و قیمتها فهرست مستندات برای عاملهای هوش مصنوعی:https://oneprovider.dev/docs/llms.txt Base URL: https://app.oneprovider.dev/partner/v1. مشخصات OpenAPI 3.1 قابلخواندن برای ماشین: https://app.oneprovider.dev/partner/v1/openapi.yaml (عمومی، بدون نیاز به توکن).
ستون «Idempotency» متدهایی را نشان میدهد که هدر Idempotency-Key را لازم دارند. دسترسی «any» یعنی هر توکن معتبر و «none» یعنی توکن لازم نیست.
| متد | مسیر | Scope | Idempotency | کاربرد |
|---|---|---|---|---|
GET | /me | any | - | توکن، دسترسیها، نماینده فروش. |
GET | /balance | read | - | موجودی نماینده فروش، رزروشده، قابل استفاده، قیمت عمده، درگاههای شارژ. |
GET | /balance/transactions | read | - | تراکنشهای موجودی (cursor). |
POST | /balance/topups | billing | الزامی | ساخت پرداخت شارژ، pay_url را برمیگرداند. |
GET | /balance/topups/{order_id} | billing | - | وضعیت پرداخت خودتان. |
GET | /pricing | read | - | قیمت عمده، تخفیف، محدودیتها. |
GET | /models | read | - | فهرست مدلها و وضعیت زنده. |
GET | /customers | read | - | فهرست مشتریان (?external_id=). |
GET | /customers/{id} | read | - | یک مشتری. |
POST | /customers | keys | - | ساخت مشتری. |
PATCH | /customers/{id} | keys | - | ویرایش نام، یادداشت، مسدودسازی (blocked). |
GET | /customers/{id}/usage | read | - | مصرف یک مشتری در همهٔ کلیدهای فعالش، به تفکیک روز و مدل (?days=1..90). |
GET | /keys | read | - | فهرست کلیدها (?status=, ?query=, ?customer_id=). |
GET | /keys/{id} | read | - | کلید بدون راز، همراه dashboard_url. |
GET | /keys/{id}/usage | read | - | مصرف روزانه و به تفکیک مدل یک کلید (?days=1..90، پیشفرض 30). |
POST | /keys | keys | الزامی | صدور کلید؛ راز یک بار برگردانده میشود. |
POST | /keys/bulk | keys | الزامی | صدور چند کلید یکسان با هم. |
PATCH | /keys/{id} | keys | - | سقف، انقضا (expires_days/hours) یا تمدید (extend_days/hours)، نام، برچسب مشتری. |
DELETE | /keys/{id} | keys | - | حذف کلید (200 یا 202). |
POST | /keys/{id}/topup | keys | الزامی | افزودن مبلغ به سقف کلید. |
POST | /keys/{id}/rotate | keys | الزامی | صدور مجدد کلید: راز جدید، راز قبلی از کار میافتد. |
POST | /keys/{id}/pause | keys | - | توقف کلید. |
POST | /keys/{id}/resume | keys | - | از سرگیری کلید. |
POST | /orders | keys | الزامی | سفارش پرداختشدهٔ مشتری: کلید جدید یا شارژ. |
GET | /orders | read | - | فهرست سفارشها (?external_order_id=). |
GET | /orders/{id} | read | - | یک سفارش. |
GET | /plans | read | - | بستههای شما. |
POST | /plans | plans | - | ساخت بسته. |
PATCH | /plans/{id} | plans | - | ویرایش بسته. |
DELETE | /plans/{id} | plans | - | حذف بسته. |
GET | /code-batches | codes | - | فهرست دستههای کد. |
POST | /code-batches | codes | الزامی | ساخت دستهٔ کد. |
GET | /code-batches/{id} | codes | - | یک دسته. |
GET | /code-batches/{id}/codes | codes | - | کدهای یک دسته (?status=). |
POST | /code-batches/{id}/revoke | codes | - | ابطال کدهای فعالنشده. |
GET | /codes/{code} | codes | - | وضعیت یک کد. |
POST | /codes/{code}/redeem | codes | الزامی | فعالسازی کد و تبدیل آن به کلید. |
GET | /stats | read | - | آمار روزانه (?days=1..90). |
GET | /audit | read | - | گزارش اقدامات (فیلترهای period، actor، action، q). |
GET | /bot | bot | - | ربات فروش و ربات پشتیبانی (بدون توکن). |
GET | /settings | read | - | تنظیمات فروشگاه: نام، راه تماس، برند، پیشوند کلید، پیام مشتری. |
PATCH | /settings | keys | - | ویرایش تنظیمات فروشگاه (فقط فیلدهای فرستادهشده). |
GET | /payment-providers | bot | - | روشهای پرداخت ربات: CryptoBot، xRocket، Platega (بدون توکن)؛ Stars همیشه فعال است. |
GET | /webhooks | webhooks | - | فهرست وبهوکها. |
POST | /webhooks | webhooks | - | ساخت وبهوک؛ راز یک بار نمایش داده میشود. |
DELETE | /webhooks/{id} | webhooks | - | حذف وبهوک. |
POST | /webhooks/{id}/test | webhooks | - | ارسال رویداد آزمایشی. |
GET | /webhooks/{id}/deliveries | webhooks | - | گزارش ارسالها. |
GET | /openapi.yaml | none | - | مشخصات OpenAPI 3.1 (عمومی). |
قواعد مشترک (صفحهبندی، خطاها، محدودیتها) در مجوزدهی و سقفها توضیح داده شدهاند.
آخرین بهروزرسانی: 2026-11-08 باگی پیدا کردید؟ @Oneproviderhelpbot