این محصول به کسب‌وکارهایی که می‌خواهند برای خدمات‌شان، به میزان مصرف کاربر (usage base)، هزینه دریافت کنند، کمک می‌کند تا بتوانند اندازه‌گیری دقیقی از مصرف هر مشتری را در هر لحظه داشته باشند.
\nهمچنین مدیریت اشتراک دوره‌ای کاربران را نیز ممکن می‌کند.
\n","_postman_id":"27629c50-a7f8-4378-8198-59a64ba582c0"},{"name":"مدل‌های درآمدی قابل اجرا","item":[{"name":"اشتراک مدت‌دار (Subscription)","item":[{"name":"با محدودیت در مقدار سهیمه هر خدمت","item":[],"id":"77f4662b-2857-4809-9f2d-686708b34941","description":"اشتراک استفاده از خدمتی مشخص برای زمان محدود، با محدودیت در میزان استفاده از این خدمت.
\nمثال: اعتبار اولیه‌ی رایگان در ازای خرید سیم‌کارت اعتباری ایرانسل در طرح گلچین(مطابق عکس). ۱۲ گیگابایت اینترنت هدیه(مدت اعتبار ۳ ماه)، ۲۰۰۰ دقیقه مکالمه رایگان با تمام خطوط داخلی کشور(مدت اعتبار ۳ ماه)، ۲۰۰۰ پیامک رایگان به تمام خطوط داخلی کشور. ۲۰۰۰ تومان اعتبار اولیه
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXcqcpKGIGYbsCaZCYZpN6SFP10kdlquOzcXE1g44CivtrmfatcLDGGZSiXAtKxKT2N4oE5LZgIsMvld0DDUSPLrrS1caMGRxmUHNl4Dr8X38RjtwX7rPxFNkefvBdsVtKzW2dB4nQ?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
","_postman_id":"77f4662b-2857-4809-9f2d-686708b34941"},{"name":"بدون محدودیت منابع","item":[],"id":"7a1a7698-52a0-4016-85fe-68be09b2be65","description":"اشتراک استفاده از خدمتی مشخص برای زمان محدود، بدون محدودیت در تعداد استفاده از این خدمت.
مثال: اشتراک فیلیمو برای دسترسی به محتواهای (فیلم و سریال) غیر رایگان
![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXf-mBuuKBJbpjONjXvDO9K55DdwXjHb4XuEZ1T9ywmfufF50aKt435F04wUideYuFJC2whAClLpyA__I5sS3JjCj701RQB08Tw0KkP_x0GNvbn3T8n87s779NfBylqwuQZzvKNN9A?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
","_postman_id":"7a1a7698-52a0-4016-85fe-68be09b2be65"}],"id":"99db4a55-c80e-41ef-afb6-e7d0218d3c55","description":"کاربر اجازه استفاده از خدمات کسب‌وکار برای مدت زمان مشخص را دریافت می‌کند.
\n","_postman_id":"99db4a55-c80e-41ef-afb6-e7d0218d3c55"},{"name":"پرداخت به میزان مصرف (Pay-As-You-Go)","item":[{"name":"پیش‌پرداخت (Pre-Paid)","item":[],"id":"7dda2b70-8250-4127-88a1-51715f750ff6","description":"کاربر ابتدا اعتبار استفاده از خدمت کسب‌وکار را خریداری می‌کند. با توجه به میزان مصرف و قیمت واحد، هر قدر که از خدمت استفاده می‌کند، از اعتبارش کسر می‌گردد تا اعتبارش به پایان رسید.
مثال: سیم‌کارت‌های اعتباری اپراتورهای همراه. ابتدا اعتبار خریداری شده توسط کاربر را ثبت می‌کنید، بعد در هر نوبت مصرف، میزان مصرف را ثبت می‌کنید که متعاقبا از اعتبار کاربر کسر میشود.
![\"خرید%20شارژ%20(پیش%20پرداخت)\"](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXepbBAEffwHYPrlvrpHSbU3WoCXUW3Tu70jVSK-6nXQ-baSIravosyDjkHpSkiQwzGmVGy4VdE4lj-1RCT40lr6haVAfHaAbWeqSLK8b-C5XTC-Xj81oo4hnYldFF7pUljvewPbpQ?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXcIGW_fIPA30dzyCFBOT5Ka7R1IrHCWwyiFRW3fEPXXRvmi2TtYrEecQaJThj5PRdqTgAID5CV0Xf8oSgooQRv8Rt8MnUicPEvjtK4AFHTRgIUXmNSSTwgW2jpJuSyt4FtiS70Mcg?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXeuLDPV52YBAi4RmH1NA-0qRmqEuH_y82_ewzFU5iFuChkWWk01lqTdQ2LqKt0aXmnZKJ2K-qfqPlravkvthHwAk5iUGAysCOEO2rHzi1x6nm_8b3k70Tukr3wfFLExDrS_Kbi3?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
\n\n![\"تعرفه‌ی%20خدمات\"](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXcFoGNhf4zdglu3B_P1t379xO0Anc7G2rMKJzKh_dOMYsS6NgzuCuDFclHye_efTXTMAEkVHh3_Mx_R3NbWp-YXzGYWAyQecIcnqyV9KbiohlsIjUB7_7vQkmMMFTnCAilm90qP?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
","_postman_id":"7dda2b70-8250-4127-88a1-51715f750ff6"},{"name":"پس‌پرداخت (Post-Paid)","item":[],"id":"f8615ab8-badb-481c-9789-d4b8e25aec83","description":"کاربر از خدمت کسب‌وکار استفاده می‌کند و با توجه به میزان مصرف و قیمت واحد، هزینه استفاده برای او ثبت میشود. در پایان دوره‌ی زمانی مشخص، جمع هزینه‌های آن دوره را پرداخت می‌کند.
مثال: سیم‌کارت‌های دائمی اپراتورهای تلفن همراه. میزان مصرف در هر بار استفاده را ثبت می‌کنید و در پایان دوره‌ی ماهیانه، مصرف به ازای هر خدمت استفاده شده(مکالمه، پیامک، اینترنت) تجمیع میشود.
![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXcEb9uewr1VcKKP03WiaJQPbBbxxeaIHbnB1Sr7elFtXsx7tR2qgEQLfnWzBiuhSlsqhmZzisXM3zmccNI5QeBGsq1ZkUiIRhxGuu1U3kfUcRkgS0quWrlG-qiyd1evJp10iqUY?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXcKgBvdBwLOta1U8cStla65C_BwfdoMvLoFxwSb0SGHqXrK0fK8qZTA9dP_HeS8sUz2s5H7VQY1AhVnYehojIetTsd-v92G3GEvxXYzL-2lJOB8E_noRuiOHxU6B7WHEiMSBm0I?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
\n\n![\"تعرفه‌ی%20خدمات\"](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXfHr73aNMbsuBvjNXuBSlJy25Yc_Im1qD0fJHwsfNCciEIB4VjrFY3Bx0Xyw2kzHdSI639qHtjGNKvl5nmnMQAB3a3CbaEythBM76Z85g-7ntFDqTeGP971LJKzD9JmGBIJLzei?key=20HC7yg2-Hx0qz-ouOpJSKWA\")
","_postman_id":"f8615ab8-badb-481c-9789-d4b8e25aec83"}],"id":"6d83ed2c-1998-4e2a-b1ba-e8beadd341dd","description":"خدمت ارائه شده، قیمت واحد مشخصی دارد. به هراندازه که کاربر مصرف کند، هزینه محاسبه میشود. پرداخت کاربر می‌تواند پیش و یا پس از مصرف باشد.
\n","_postman_id":"6d83ed2c-1998-4e2a-b1ba-e8beadd341dd"}],"id":"8f17911f-22a2-47fe-a21b-6b511636f852","description":"دو مدل درآمدی اصلی با این محصول قابل پشتیبانی ست.
\nاشتراک مدت‌دار
\nپرداخت به اندازه مصرف
\nهر کدام نیز در دو گونه.
\nاشتراک مدت‌دار:
\nبا محدودیت منابع
\nبدون محدودیت منابع
\nپرداخت به اندازه مصرف
\nپیش پرداخت
\nپس پرداخت
\nدر ادامه هر مدل درآمدی به همراه مثال توضیح داده شده.
\n","_postman_id":"8f17911f-22a2-47fe-a21b-6b511636f852"},{"name":"چالش‌های اصلی در سرویس دهی به کاربر در روش usage base","item":[],"id":"8a7685be-b352-4a28-a2e2-c5ea3cb031d5","description":"آیا کاربرم مجاز به استفاده از سرویس است؟
\nبرای کاربرم این میزان مصرف جدید را ثبت کن.
\nمانده موجودی قابل مصرف کاربرم از سرویس من و تاریخ انقضای آن چقدر و چه زمانی است؟
\nاین اولین قدم برای یک کاربر است که مشخص می‌کند چه اعتبار، بسته یا اشتراکی در دسترس اوست. ثبت اشتراک خدمات پیش‌نیاز ثبت هرگونه استفاده است.
\nاطلاعات مصرف کاربر از یک اشتراک خدمات ثبت‌شده. «استفاده» تنها زمانی امکان‌پذیر است که یک اشتراک خدمات برای کاربر ثبت شده باشد.
\nمدلی که در آن کاربر برای یک بازه زمانی مشخص، به خدمات دسترسی دارد. ممکن است بدون محدودیت یا با محدودیت منابع باشد.
\nمدلی که در آن هزینه براساس میزان استفاده کاربر از خدمات محاسبه میشود.
\nکاربر ابتدا مبلغی را پرداخت کرده و از اعتبار آن برای استفاده از خدمات کسر میشود.
\nکاربر از خدمات استفاده می‌کند و هزینه در پایان دوره محاسبه و پرداخت میشود.
\nبسته‌ها (Bundles)
\nبسته (Asset)
هر نوع خدمت، محصول، یا داده‌ای که در سیستم مدیریت میشود، مثل حجم اینترنت، تعداد پیامک، یا زمان مکالمه.
*_سهمیه (Quota)__*_میزان مشخصی از استفاده که کاربر مجاز به مصرف آن است. سهمیه می‌تواند محدودیت زمانی (مثلاً یک ماه) یا منابع مشخص (مثلاً ۲۰ گیگابایت اینترنت) داشته باشد.
\nبسته قرضی
\nبسته معتبر
\nاین سرویس بلافاصله پس از ثبت‌نام، از طریق API قابل استفاده‌ست.
\nپس از ثبت‌نام، مقادیر api_key و base_url به شما داده میشود.
\nمستندات APIها از اینجا قابل مشاهدهست.
\nتست APIها در مرورگر از اینجا ممکن است.
\nنمونه API در postman به ازای هر روش درآمدی، در بخش «هر روش درآمدی را چگونه راه‌اندازی کنم؟»، در ادامه قابل مشاهده‌است.
\nتوجه شود که این سرویس، هیچ اطلاعی از سامانه فروش شما ندارد، برای داشتن میزان دقیق و درلحظه از مصرف کاربر مورد استفاده قرار می‌گیرد و با اطلاعاتی که شما از اشتراک یا اعتبار تخصیص داده شده به کاربر به آن می‌دهید، کار را شروع می‌کند.
\nArgs:
\n- user_id: uuid.UUID, owner of the enrollment\n- price: Decimal, price of the enrollment\n- invoice_id: str | None, invoice id of the enrollment if any\n- start_at: datetime, start date of the enrollment, default set now if not provided\n- expire_at: datetime | None, expiration date of the enrollment for the selected bundles, default None\n- duration: int | None, duration of the enrollment in days, default None\n- status: \"active\" | \"inactive\", the status of the enrollment, default \"active\"\n- bundles: list[Bundle], list of bundles that are included in the enrollment. Each bundle should have a asset, quota, and unit.\n asset: str, the asset name (For example, \"Storage\" in storage service, \"Tokens\" in LLM API service, ...)\n quota: Decimal, the quota of the asset\n unit: str | None, the unit of the quota (For example, \"GB\" in storage service, \"Tokens\" in LLM API service, ...) if any\n- variant: str | None, the variant limitation of the enrollment. For example, \"car\" category in a classified advertisements service. For normal enrollment, it would be None and it is not to be provided.\n- meta_data: dict | None = None, additional metadata for the enrollment that will be stored as a dictionary.\n\nReturns:
\ndict: The created enrollment item.\n\nRaises:
\n- AuthorizationException: If the user is not authorized to create an enrollment.\n\nبدنه درخواست(http body)
\nپاسخ(توضیح مقادیری که در بدنه درخواست نبوده)
\nانواع پاسخ موفق و ناموفق در بخش example قابل مشاهدهست.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","enrollments",""],"host":["{{Your_Base_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8642f92a-0bfd-43fe-9a3f-0f379f1c6d17","name":"successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": 12288,\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": 2000,\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": 2000\n },\n {\n \"asset\": \"credit\",\n \"quota\": 20000,\n \"unit\": \"IRR\"\n }\n ],\n \"price\": 2000000,\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931Z\",\n //\"expire_at\": \"2024-12-12T07:53:44.931Z\",\n \"duration_days\": 90,\n \"status\": \"active\",\n \"acquisition_type\": \"purchased\",\n //\"variant\": \"string\",\n \"meta_data\": {}\n //,\"due_date\": \"2024-12-12T07:53:44.931Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 06:50:34 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"885"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=3VNbYxESU0w1VdaUfn4pE6VMGVy7HatbszSbpLL0Tne34Rtxedu4c1ZYgOh8ErLRdnLdzd8i%2F1uVNLW7Nt1VsZn81LypWGWYUahs88SYM72cNHaqBd5wHN%2FLaBhXuA%2BQ\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=14068&min_rtt=13907&rtt_var=5330&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2833&recv_bytes=2065&delivery_rate=208240&cwnd=178&unsent_bytes=0&cid=83f94886ab8db27d&ts=667&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=120186&min_rtt=118722&rtt_var=26548&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2802&recv_bytes=1426&delivery_rate=32519&cwnd=252&unsent_bytes=0&cid=3b29f0ce606f214f&ts=938&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1c42a95c01d372-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2024-12-14T06:50:34.588000\",\n \"updated_at\": \"2024-12-14T06:50:34.589000\",\n \"is_deleted\": false,\n \"meta_data\": {},\n \"uid\": \"ca1d528c-75f8-4288-a452-4c0ddd2f01cd\",\n \"business_name\": \"uFaaS\",\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"price\": \"2000000\",\n \"acquisition_type\": \"purchased\",\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931000\",\n \"expire_at\": \"2025-03-12T07:53:44.931000\",\n \"duration\": 90,\n \"status\": \"active\",\n \"bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": \"12288\",\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": \"2000\",\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": \"2000\",\n \"unit\": null\n },\n {\n \"asset\": \"credit\",\n \"quota\": \"20000\",\n \"unit\": \"IRR\"\n }\n ],\n \"variant\": null,\n \"due_date\": null,\n \"paid_at\": null,\n \"leftover_bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": \"12288\",\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": \"2000\",\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": \"2000\",\n \"unit\": null\n },\n {\n \"asset\": \"credit\",\n \"quota\": \"20000\",\n \"unit\": \"IRR\"\n }\n ]\n}"},{"id":"e8b8282f-f435-4687-9294-fd7d943e6f1e","name":"invalid user_id type","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d4\",\n \"bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": 12288,\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": 2000,\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": 2000\n },\n {\n \"asset\": \"credit\",\n \"quota\": 20000,\n \"unit\": \"IRR\"\n }\n ],\n \"price\": 2000000,\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931Z\",\n //\"expire_at\": \"2024-12-12T07:53:44.931Z\",\n \"duration_days\": 90,\n \"status\": \"active\",\n \"acquisition_type\": \"purchased\",\n //\"variant\": \"string\",\n \"meta_data\": {}\n //,\"due_date\": \"2024-12-12T07:53:44.931Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 07:07:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"272"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=3BLf%2Fh9H%2BLELNTBL8wqJ1Kkjhq1De7TsIgC6xaru7HCd3mO8Nzy9Mc9h%2BrL0FweHWlsikIOJn0ffL9Zv9ZIDkB0th6BQsv12wc%2FXNvxDz7nAx4tFBcK465GbccZtD8ks\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13688&min_rtt=13653&rtt_var=5145&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2833&recv_bytes=2065&delivery_rate=212114&cwnd=43&unsent_bytes=0&cid=cb6e6712e92313ee&ts=119&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=166583&min_rtt=125902&rtt_var=71937&sent=5&recv=6&lost=0&retrans=0&sent_bytes=2800&recv_bytes=1424&delivery_rate=30688&cwnd=252&unsent_bytes=0&cid=751e8331a65c6780&ts=1401&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1c5be2cf0b3625-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"type\": \"uuid_parsing\",\n \"loc\": [\n \"body\",\n \"user_id\"\n ],\n \"msg\": \"Input should be a valid UUID, invalid group length in group 4: expected 12, found 10\",\n \"input\": \"f47ac10b-58cc-4372-a567-0e02b2c3d4\",\n \"ctx\": {\n \"error\": \"invalid group length in group 4: expected 12, found 10\"\n }\n }\n ]\n}"},{"id":"a1e8b41d-f0c6-4bfe-8556-6d336ae628f0","name":"expire_at and duration filled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": 12288,\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": 2000,\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": 2000\n },\n {\n \"asset\": \"credit\",\n \"quota\": 20000,\n \"unit\": \"IRR\"\n }\n ],\n \"price\": 2000000,\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931Z\",\n \"expire_at\": \"2025-01-12T07:53:44.931Z\",\n \"duration_days\": 90,\n \"status\": \"active\",\n \"acquisition_type\": \"purchased\",\n //\"variant\": \"string\",\n \"meta_data\": {}\n //,\"due_date\": \"2024-12-12T07:53:44.931Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 07:22:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"588"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=%2F9QsxmriQspz%2BZYQKaKmbJe1Wl8heZTZYC2R%2F3lHkFdxO9mQxcqFW8yjqPmjLTbwhItijstgzYrHIMw1WMiLU6FstrHz1TWkFsiDt7JDV%2FoFcZDbjxa%2Bf0q%2F%2BrfUw2ya\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13772&min_rtt=13726&rtt_var=5180&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2832&recv_bytes=2105&delivery_rate=210986&cwnd=177&unsent_bytes=0&cid=7080e12b8c42739e&ts=119&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=114439&min_rtt=113930&rtt_var=32926&sent=5&recv=6&lost=0&retrans=0&sent_bytes=2800&recv_bytes=1466&delivery_rate=33279&cwnd=252&unsent_bytes=0&cid=b437637358c86972&ts=2121&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1c7196ba4b903a-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"type\": \"value_error\",\n \"loc\": [\n \"body\"\n ],\n \"msg\": \"Value error, Only one of expire_at or duration_days should be provided\",\n \"input\": {\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": 12288,\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": 2000,\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": 2000\n },\n {\n \"asset\": \"credit\",\n \"quota\": 20000,\n \"unit\": \"IRR\"\n }\n ],\n \"price\": 2000000,\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931Z\",\n \"expire_at\": \"2025-01-12T07:53:44.931Z\",\n \"duration_days\": 90,\n \"status\": \"active\",\n \"acquisition_type\": \"purchased\",\n \"meta_data\": {}\n },\n \"ctx\": {\n \"error\": {}\n }\n }\n ]\n}"}],"_postman_id":"2b4497cf-7b6c-4fef-954f-d5be2c073566"}],"id":"a9d97abd-2f26-4022-8e62-dea9f9b349b0","description":"ثبت اشتراک خدمات برای یک کاربر با شناسه کاربری، به همراه یک یا چند بسته(asset) و سهمیه(quota).
\nمیتوانیم مقادیر مشخص شده در body که در ادامه قابل مشاهده است را در زمان ثبت، ارسال کنیم.
\n","_postman_id":"a9d97abd-2f26-4022-8e62-dea9f9b349b0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"مشاهده لیست همه اشتراک خدمات ثبت شده","item":[{"name":"list of enrollments","id":"616c35b9-5d33-432d-af09-06bd0cbd9601","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/","description":"انواع پاسخ موفق و ناموفق در بخش example قابل مشاهدهست.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","enrollments",""],"host":["{{Your_Base_URL}}"],"query":[{"disabled":true,"description":{"content":"integer (Offset) >= 0\nDefault: 0\nتعداد رکوردی که از آن عبور شود و بعد از آن نمایش داده شود.\nپیش‌فرض: 0
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"integer (Limit) [ 0 .. 100 ]\nDefault: 10\nعداد رکوردی که نمایش داده شود.\nپیش‌فرض: 10
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"string \nشناسه کاربر. دریافت همه اشتراک خدمات ثبت شده‌ی یک کاربر از طریق شناسه آن کاربر
\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"string\nدریافت همه اشتراک خدمات ثبت شده‌ای که دارای بسته‌ی مشخصی هستند
\n","type":"text/plain"},"key":"asset","value":""},{"disabled":true,"description":{"content":"string
\nدریافت همه اشتراک خدمات ثبت شده که دارای نوع خاصی هستند.
\n","type":"text/plain"},"key":"variant","value":""},{"disabled":true,"description":{"content":"boolean (Is Valid)\nDefault: true\nدریافت همه اشتراک خدماتی که معتبر هستند.\nپیش‌فرض: درست.
\n","type":"text/plain"},"key":"is_valid","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های ساخته شده از تاریخ
\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های ساخته شده تا تاریخ
\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با تاریخ شروع از
\n","type":"text/plain"},"key":"start_at_from","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با تاریخ شروع تا
\n","type":"text/plain"},"key":"start_at_to","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با تاریخ انقضا از
\n","type":"text/plain"},"key":"expire_at_from","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با تاریخ انقضا تا
\n","type":"text/plain"},"key":"expire_at_to","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با مهلت پرداخت از
\n","type":"text/plain"},"key":"due_date_from","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با مهلت پرداخت تا
\n","type":"text/plain"},"key":"due_date_to","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با پرداخت شده از
\n","type":"text/plain"},"key":"paid_at_from","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی اشتراک‌های با پرداخت شده تا
\n","type":"text/plain"},"key":"paid_at_to","value":""}],"variable":[]}},"response":[{"id":"d99a3713-27b0-456b-9619-2cb7cae6fd0e","name":"successful list of enrollments","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/","host":["{{Your_Base_URL}}"],"path":["api","v1","apps","saas","enrollments",""],"query":[{"key":"offset","value":null,"description":"integer (Offset) >= 0\nDefault: 0\nتعداد رکوردی که از آن عبور شود و بعد از آن نمایش داده شود.\nپیش‌فرض: 0","disabled":true},{"key":"limit","value":null,"description":"integer (Limit) [ 0 .. 100 ]\nDefault: 10\nعداد رکوردی که نمایش داده شود.\nپیش‌فرض: 10","disabled":true},{"key":"user_id","value":null,"description":"stringبرای مشاهده همه‌ی اشتراک خدمات ثبت شده از این روش اقدام می‌کنیم. میتوانیم با پارامترهای مختلف، پاسخ خروجی را فیلتر کنیم. پارامترهای مجاز در ادامه قابل مشاهده هستند.
\n","_postman_id":"624e031e-b8e4-4728-8ba0-493f6ee37337","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"مشاهده یک اشتراک خدمات ثبت شده مشخص","item":[{"name":"Retrieve an enrollment","id":"3d497a1c-1efd-419a-a120-615d8c03191f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/{uid}","description":"انواع پاسخ موفق و ناموفق در بخش example قابل مشاهدهست.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","enrollments","{uid}"],"host":["{{Your_Base_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d2cf88e5-1121-45a4-a941-d5d198c15b81","name":"successful retrieve an item","originalRequest":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/ca1d528c-75f8-4288-a452-4c0ddd2f01cd"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 08:13:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=vQvhB6QLrGpmkAGAJxUKry5D7%2F0xViLBgfApB2b7o8KBMl3lro7aRJkJF9nLQcd%2B6Ign0kcOXMlMIQ6RxnIq2ZH3mUJg9QMPTAkbIGx9x6B63bgyfCZ%2Frk7hhblPSJZa\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13620&min_rtt=13618&rtt_var=5110&sent=4&recv=6&lost=0&retrans=0&sent_bytes=2833&recv_bytes=1332&delivery_rate=212410&cwnd=252&unsent_bytes=0&cid=18758dae431de9ae&ts=116&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=115532&min_rtt=112975&rtt_var=12057&sent=43&recv=43&lost=0&retrans=0&sent_bytes=5644&recv_bytes=1474&delivery_rate=33594&cwnd=257&unsent_bytes=0&cid=acb74ff9c2e06917&ts=36164&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1cbc2afd959004-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2024-12-14T06:50:34.588000\",\n \"updated_at\": \"2024-12-14T06:50:34.589000\",\n \"is_deleted\": false,\n \"meta_data\": {},\n \"uid\": \"ca1d528c-75f8-4288-a452-4c0ddd2f01cd\",\n \"business_name\": \"uFaaS\",\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"price\": \"2000000\",\n \"acquisition_type\": \"purchased\",\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931000\",\n \"expire_at\": \"2025-03-12T07:53:44.931000\",\n \"duration\": 90,\n \"status\": \"active\",\n \"bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": \"12288\",\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": \"2000\",\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": \"2000\",\n \"unit\": null\n },\n {\n \"asset\": \"credit\",\n \"quota\": \"20000\",\n \"unit\": \"IRR\"\n }\n ],\n \"variant\": null,\n \"due_date\": null,\n \"paid_at\": null,\n \"leftover_bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": \"12288\",\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": \"2000\",\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": \"2000\",\n \"unit\": null\n },\n {\n \"asset\": \"credit\",\n \"quota\": \"20000\",\n \"unit\": \"IRR\"\n }\n ]\n}"},{"id":"a3f5c9bc-ef26-44ae-9195-1f0f6c3f0ae5","name":"bad enrollment_id","originalRequest":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/f47ac10b-58cc-4372-a567-0e02b2c3d479"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 08:47:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=g5IGjGrGaXFcds%2F1zCopmvwqRvz8gHy%2BJjg3LVXcwiIdOraykBOo%2BPVds%2F7Vqhw8VD3ZHtDSiI64ZuOCYprHJQPqfENSNa%2Baqn2k58s19PxI91ZI8KV86SwCNhwm9HPF\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13373&min_rtt=13366&rtt_var=5027&sent=4&recv=6&lost=0&retrans=0&sent_bytes=2833&recv_bytes=1332&delivery_rate=215716&cwnd=92&unsent_bytes=0&cid=7d96c0633b0d723a&ts=962&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=106339&min_rtt=104289&rtt_var=31168&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2800&recv_bytes=715&delivery_rate=37047&cwnd=252&unsent_bytes=0&cid=fde4ce8ac8f7dca2&ts=2645&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1cede44d52dbc5-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Enrollment not found\",\n \"error\": \"item_not_found\"\n}"},{"id":"b5741fdc-7095-448a-9f6d-d3e841a47c22","name":"default 4xx respond","originalRequest":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/{uid}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n\t{\n \t\"loc\": [\n \t\"string\"\n \t],\n \t\"msg\": \"string\",\n \t\"type\": \"string\"\n\t}\n ]\n}"}],"_postman_id":"3d497a1c-1efd-419a-a120-615d8c03191f"}],"id":"ca7e9588-e600-43b0-9f06-387c1e191c51","description":"برای دیدن یک اشتراک خدمات مشخص، از این روش اقدام می‌کنیم. با وارد کردن شناسه اشتراک خدمات ثبت شده و ارسال درخواست، اطلاعات آن را در پاسخ مشاهده می‌کنیم.
\n","_postman_id":"ca7e9588-e600-43b0-9f06-387c1e191c51","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"به روز رسانی یک اشتراک خدمات ثبت شده","item":[{"name":"Update an enrollment's Item(s)","id":"20d5aad4-641e-4ee6-8a0c-5599e21915d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"price\": \"0\",\n \"invoice_id\": \"string\",\n \"status\": \"active\",\n \"acquisition_type\": \"trial\",\n \"meta_data\": {},\n \"due_date\": \"2019-08-24T14:15:22Z\",\n \"paid_at\": \"2019-08-24T14:15:22Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/{uid}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","enrollments","{uid}"],"host":["{{Your_Base_URL}}"],"query":[],"variable":[]}},"response":[{"id":"53366bbd-14ed-45c2-9a4f-0ede0926a289","name":"successful update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"price\": \"199999\",\n \"acquisition_type\": \"trial\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/8a434ef8-6917-4a3c-8088-1c621b97bb49"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 09:02:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=r47KFfWOSJSJJ%2FcWHtS5DTtYAA7RsH4Tjqi6MAADWoNValzaZDX8K5RPt22GO3eFWM7ZDLVHFi3o0AWKBZON8%2FJgJCVVT8LkdoXisrnplDOphA0CRuxZorbQQOJRskaF\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=14587&min_rtt=14324&rtt_var=5559&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2832&recv_bytes=1462&delivery_rate=202178&cwnd=71&unsent_bytes=0&cid=a5f5a3cfa632de72&ts=1008&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=117071&min_rtt=116625&rtt_var=25177&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2801&recv_bytes=823&delivery_rate=32595&cwnd=252&unsent_bytes=0&cid=f9956e781a401522&ts=2933&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1d0402ae382c02-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2024-12-14T07:11:22.659000\",\n \"updated_at\": \"2024-12-14T09:02:36.156000\",\n \"is_deleted\": false,\n \"meta_data\": {},\n \"uid\": \"8a434ef8-6917-4a3c-8088-1c621b97bb49\",\n \"business_name\": \"uFaaS\",\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"price\": \"199999\",\n \"acquisition_type\": \"trial\",\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931000\",\n \"expire_at\": \"2025-03-12T07:53:44.931000\",\n \"duration\": 90,\n \"status\": \"active\",\n \"bundles\": [],\n \"variant\": null,\n \"due_date\": null,\n \"paid_at\": null,\n \"leftover_bundles\": []\n}"},{"id":"601c483a-de2c-4c7d-bf59-f40310659695","name":"invalid request in body","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/8a434ef8-6917-4a3c-8088-1c621b97bb49"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 09:10:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=3SNut7RzGvZkr32xG%2B6uIEdlCiHui3izScH%2BdxwLTeWa5U5gii1CZ2KUAtMtTYHcTTfe1prM3gJOdelFK8Zv2EJGMilk%2BNTOewsgre3KY0fBykXcjmktJ1826HJuEYHE\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13874&min_rtt=13863&rtt_var=5221&sent=4&recv=6&lost=0&retrans=0&sent_bytes=2831&recv_bytes=1351&delivery_rate=207568&cwnd=160&unsent_bytes=0&cid=d931b323c5a234d0&ts=121&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=116351&min_rtt=116044&rtt_var=44131&sent=5&recv=5&lost=0&retrans=0&sent_bytes=2801&recv_bytes=736&delivery_rate=32606&cwnd=252&unsent_bytes=0&cid=28d44ee5846171c2&ts=487&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1d0f233d5665c5-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"type\": \"missing\",\n \"loc\": [\n \"body\"\n ],\n \"msg\": \"Field required\",\n \"input\": null\n }\n ]\n}"}],"_postman_id":"20d5aad4-641e-4ee6-8a0c-5599e21915d9"}],"id":"68d0b9a4-0e96-4b5b-a4ed-30f98fbf5258","description":"با ارسال یک و یا همه موارد ذکر شده در بخش body، میتوانیم اطلاعات اشتراک خدمات ثبت شده را به روز رسانی کنیم.
\nما تنها میتوانیم پارامترهایی که در « استفاده‌های ثبت شده برای یک اشتراک خدمات»، خللی ایجاد نمی‌کند را تغییر دهیم.
\nپس تنها مقادیر پارامترهای ذکر شده در ادامه را میتوانیم ویرایش کنیم.
\nبدنه درخواست(http body)
\n","_postman_id":"68d0b9a4-0e96-4b5b-a4ed-30f98fbf5258","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"پاک کردن یک اشتراک خدمات ثبت شده","item":[{"name":"delete an enrollment","id":"44633309-0683-4f1b-92c9-30fa86dc210e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/{uid}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","enrollments","{uid}"],"host":["{{Your_Base_URL}}"],"query":[],"variable":[]}},"response":[{"id":"aaddea54-bf11-4603-bc14-698ee28ff7a0","name":"successful delete","originalRequest":{"method":"DELETE","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/8a434ef8-6917-4a3c-8088-1c621b97bb49"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 09:22:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=3Pww%2BmeC6laG6UQDANPECHqcPb0heAMD80ahe3HaXi2sIL0Es51PXY72ZjYLtcRb8EdtOyqCUsQbOJzlg0fXVI2Bx29Tg8oUFkRWoB3%2FseWu5i7lViF6BzNn%2BvoOhdNk\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=14084&min_rtt=13875&rtt_var=5352&sent=4&recv=6&lost=0&retrans=0&sent_bytes=2833&recv_bytes=1333&delivery_rate=208720&cwnd=167&unsent_bytes=0&cid=708ef391f31de572&ts=986&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=121364&min_rtt=118309&rtt_var=28171&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2801&recv_bytes=718&delivery_rate=32655&cwnd=252&unsent_bytes=0&cid=70ee4aae3cdc26f5&ts=2771&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1d21a52912dc70-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2024-12-14T07:11:22.659000\",\n \"updated_at\": \"2024-12-14T09:22:49.844000\",\n \"is_deleted\": true,\n \"meta_data\": {},\n \"uid\": \"8a434ef8-6917-4a3c-8088-1c621b97bb49\",\n \"business_name\": \"uFaaS\",\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"price\": \"199999\",\n \"acquisition_type\": \"trial\",\n \"invoice_id\": \"986\",\n \"start_at\": \"2024-12-12T07:53:44.931000\",\n \"expire_at\": \"2025-03-12T07:53:44.931000\",\n \"duration\": 90,\n \"status\": \"active\",\n \"bundles\": [],\n \"variant\": null,\n \"due_date\": null,\n \"paid_at\": null\n}"},{"id":"48e9c6a0-87fe-4f23-92c1-debc87c5b563","name":"invalid enrollment_id sent","originalRequest":{"method":"DELETE","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/enrollments/8a434ef8-6917-4a3c-8088-1c621b97bb"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 09:23:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"22"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=d7F6EQR6CJjBc89lGtDkTsRk9Z4NfKlyxjPVicecEyZLWUGguN1Q7HGYrAe2lqRn1DLNIZIceE4l5mQKU%2FDuQ%2FRCyZckNHp4tQn%2Bv%2FyTaBMhIj3emL%2FjYauYB6wg1%2Bl4\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13910&min_rtt=13799&rtt_var=5254&sent=4&recv=6&lost=0&retrans=0&sent_bytes=2832&recv_bytes=1333&delivery_rate=209870&cwnd=89&unsent_bytes=0&cid=0a60b461b2dca5d1&ts=108&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=112117&min_rtt=111833&rtt_var=42505&sent=5&recv=5&lost=0&retrans=0&sent_bytes=2801&recv_bytes=716&delivery_rate=33863&cwnd=252&unsent_bytes=0&cid=f34b785c2cd652c9&ts=367&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1d231e9ceed411-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Not Found\"\n}"}],"_postman_id":"44633309-0683-4f1b-92c9-30fa86dc210e"}],"id":"a70b3240-0f38-485f-91ec-51d931832b7a","description":"جهت پاک کردن یک اشتراک خدمات ثبت شده، از این روش اقدام می‌کنیم.
\nتوجه شود که در صورت پاک شدن موفق یک اشتراک خدمات، مقدار عبارت is_deleted از false به true تغییر می‌کند.
اشتراک خدمات.
\nدر ادامه، همه‌ی APIهای در مورد اشتراک خدمات را می‌توانید ملاحظه کنید.
\nاین اولین قدم برای یک کسب‌وکار است که مشخص می‌کند چه اعتبار، بسته یا اشتراکی جهت مصرف هر کاربر، در دسترس اوست. ثبت اشتراک خدمات پیش‌نیاز ثبت هرگونه استفاده است.
\n","_postman_id":"a1d27570-7d38-4a67-85e9-7f95fc8b604e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"Usages","item":[{"name":"ثبت استفاده","item":[{"name":"register a usage","id":"8876925c-2cb8-4512-a9d5-5a82b923f4f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n //\"enrollment_id\": \"ca1d528c-75f8-4288-a452-4c0ddd2f01cd\",\n \"asset\": \"phone_call\",\n \"amount\": 43\n //,\"variant\": \"string\",\n //\"meta_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/","description":"در پاسخ موفق:
\nدر پارامتر consumptions لیستی از همه اشتراک خدمات ثبت شده‌ای که در این استفاده، از آنها مصرف شده دریافت می‌کنید. چنانچه مقدار مصرف درخواستی(amount) از یک asset، کمتر یا مساوی مقدار موجودی یک اشتراک خدمات ثبت شده باشد، تنها یک اشتراک خدمات در پارامتر parts ارسال میشود.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","usages",""],"host":["{{Your_Base_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7d96e082-89ea-4a43-9938-3b515cd7a326","name":"successful usage registration with user_id","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n //\"enrollment_id\": \"ca1d528c-75f8-4288-a452-4c0ddd2f01cd\",\n \"asset\": \"internet\",\n \"amount\": 580\n //,\"variant\": \"string\",\n //\"meta_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 10:28:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"592"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=IIJDrOoTqOqSXuWGsf9NfXvFjDeJh6lo3RCS%2B1y%2BUf3HaHknh%2FVRl45Ma%2B1IYEt32FLllq5G1M7fHrs%2BQWg3WLNZb3hzCXtIYUou5YyIdGZ460TGx7pg67xbBhqoGKZM\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=15149&min_rtt=13974&rtt_var=6079&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2831&recv_bytes=1471&delivery_rate=207242&cwnd=111&unsent_bytes=0&cid=2c966036b3974da6&ts=633&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=108087&min_rtt=107128&rtt_var=30901&sent=8&recv=7&lost=0&retrans=0&sent_bytes=4335&recv_bytes=1344&delivery_rate=35950&cwnd=254&unsent_bytes=0&cid=3d674e2b14ab16bf&ts=33577&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1d81a68a0dd356-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2024-12-14T10:28:20.331000\",\n \"updated_at\": \"2024-12-14T10:28:20.332000\",\n \"is_deleted\": false,\n \"meta_data\": null,\n \"uid\": \"4bcdfa4a-020e-40b5-83f9-8551297ffb8c\",\n \"business_name\": \"uFaaS\",\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"consumptions\": [\n {\n \"enrollment_id\": \"ca1d528c-75f8-4288-a452-4c0ddd2f01cd\",\n \"amount\": \"580\",\n \"leftover_bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": \"11708\",\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": \"2000\",\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": \"2000\",\n \"unit\": null\n },\n {\n \"asset\": \"credit\",\n \"quota\": \"20000\",\n \"unit\": \"IRR\"\n }\n ]\n }\n ],\n \"asset\": \"internet\",\n \"amount\": \"580\",\n \"variant\": null\n}"},{"id":"dbeddf92-b3ae-4215-af5e-53dcc006ed26","name":"insufficient enrollment for usage","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n //\"enrollment_id\": \"ca1d528c-75f8-4288-a452-4c0ddd2f01cd\",\n \"asset\": \"phone_call\",\n \"amount\": 43\n //,\"variant\": \"string\",\n //\"meta_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/"},"status":"Payment Required","code":402,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 10:47:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"114"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=Fi1QfcoKIloWpk6uvstaHShpmQ%2F%2FIVRz8EwkRZac3W9WJasg6MD4iTqNNtILwUpu0500OUh0vdjfsjRcyUVYcvtN5ALlavUAp%2F%2FWHWBTdR%2B14pEO8YtU%2B5MgNW7br7Sy\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=14185&min_rtt=13843&rtt_var=5435&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2832&recv_bytes=1470&delivery_rate=209203&cwnd=77&unsent_bytes=0&cid=cb279457a94d37bb&ts=120&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=113736&min_rtt=113014&rtt_var=43825&sent=5&recv=4&lost=0&retrans=0&sent_bytes=2801&recv_bytes=833&delivery_rate=32527&cwnd=252&unsent_bytes=0&cid=0e7f5af0e081b6fa&ts=460&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1d9db03944d9dc-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not enough available resources in active enrollments for the usage\",\n \"error\": \"insufficient_enrollment\"\n}"}],"_postman_id":"8876925c-2cb8-4512-a9d5-5a82b923f4f2"}],"id":"43d8729e-dcda-404c-858f-67728c13fb29","description":"یک enrollment_id یا یک user_id به همراه یک asset و amount حتما باید ارسال گردد.
\nدر صورت عدم ارسال enrollment_id مناسب‌ترین اشتراک خدمات ثبت شده کاربر جهت ثبت مصرف انتخاب میشود.
\nمناسب‌ترین اشتراک خدمات با شرایط زیر انتخاب میشود.
\nاشتراک خدماتی که بسته(asset) و گونه(variant)(در صورت ارسال) مشابه با استفاده‌ی درخواست شده دارند.
\nاشتراک خدماتی که زودتر منقضی میشود.
\nدر پاسخ این api، در پارامتر consumptions لیستی از همه اشتراک خدمات ثبت شده‌ای که در این استفاده، از آنها مصرف شده دریافت می‌کنید. چنانچه مقدار مصرف درخواستی(amount) از یک asset، کمتر یا مساوی مقدار موجودی یک اشتراک خدمات ثبت شده باشد، تنها یک اشتراک خدمات در پارامتر consumptions ارسال میشود.
\nارسال پاسخ به این شکل(در consumptions و به صورت لیستی از enrollmentها) بدین جهت است که برای یک «درخواست استفاده»ی مشخص، تنها یک رکورد وجود داشته باشد. با این پیاده‌سازی، تحلیل‌های آتی و همچین لغو یک استفاده ثبت شده نیز بسیار ساده‌تر انجام می‌پذیرد.
\nبدنه درخواست(http body)
\n","_postman_id":"43d8729e-dcda-404c-858f-67728c13fb29","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"مشاهده استفاده‌های ثبت شده","item":[{"name":"list of usages","id":"a55f07f5-35b5-42c7-b018-1300ae059c25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","usages",""],"host":["{{Your_Base_URL}}"],"query":[{"disabled":true,"description":{"content":"integer (Offset) >= 0\nDefault: 0\nتعداد رکوردی که از آن عبور شود و بعد از آن نمایش داده شود.\nپیش‌فرض: 0
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"integer (Limit) [ 0 .. 100 ]\nDefault: 10\nعداد رکوردی که نمایش داده شود.\nپیش‌فرض: 10
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"string \nشناسه کاربر. دریافت همه استفاده‌های ثبت شده‌ی یک کاربر از طریق شناسه آن کاربر
\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"string\nبسته
\n","type":"text/plain"},"key":"asset","value":""},{"disabled":true,"description":{"content":"string\n*این پارامتر برای بیشتر کسب‌وکارها مورد استفاده قرار نمی‌گیرد. اگر کسب‌وکاری باشید که مورد نیاز شما باشد، حتما به شما خواهیم گفت.
\nمحدودیت دسته‌بندی یا گونه و نوع در اشتراک. مثلا در اپلیکیشن دیوار، بسته آگهی مخصوص دسته‌بندی خودرو، یعنی این بسته تنها برای آگهی‌های خودرو قابل استفاده است.
\n","type":"text/plain"},"key":"variant","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی استفاده‌های ثبت شده از
\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"string (date-time)\nهمه‌ی استفاده‌های ثبت شده تا
\n","type":"text/plain"},"key":"created_at_to","value":""}],"variable":[]}},"response":[{"id":"21cab13a-1b1d-426a-8a7e-43fa979fc1a2","name":"successful list of usages","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{Your_Base_URL}}/api/v1/apps/saas/usages/","host":["{{Your_Base_URL}}"],"path":["api","v1","apps","saas","usages",""],"query":[{"key":"offset","value":"","description":"integer (Offset) >= 0\nDefault: 0\nتعداد رکوردی که از آن عبور شود و بعد از آن نمایش داده شود.\nپیش‌فرض: 0","type":"text","disabled":true},{"key":"limit","value":"","description":"integer (Limit) [ 0 .. 100 ]\nDefault: 10\nعداد رکوردی که نمایش داده شود.\nپیش‌فرض: 10","type":"text","disabled":true},{"key":"user_id","value":"","description":"stringبرای مشاهده همه‌ی استفاده‌های ثبت شده از این روش اقدام می‌کنیم. میتوانیم با پارامترهای مختلف، پاسخ خروجی را فیلتر کنیم. پارامترهای مجاز در ادامه قابل مشاهده هستند.
\n","_postman_id":"af518017-2993-4bec-b917-06454484b9c8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"مشاهده‌ی یک استفاده مشخص","item":[{"name":"Retrieve an usage","id":"d04a0e4e-c793-4a6f-bd31-28567df6d67d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/{uid}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","usages","{uid}"],"host":["{{Your_Base_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5ffa01c8-6e6e-4bb5-8348-23371d0f48df","name":"successful retrieve a usage","originalRequest":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/a39c5ec8-9d6b-441f-a0f6-e2506662f07c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 11:55:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=Au3s34VmUXsB2XbTFgsITGHOncj9H%2FURuIQ%2FIlk6RzfFvlgq3ZbdDOoVv%2FioAd4URD2%2BMZ4LXSYOQ%2FMRgaSxieLJBD525UoA2khZL%2B7QLqakC%2FE9%2FF1ZLpFaPQnlGv99\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13687&min_rtt=13593&rtt_var=5165&sent=4&recv=6&lost=0&retrans=0&sent_bytes=2832&recv_bytes=1327&delivery_rate=213050&cwnd=252&unsent_bytes=0&cid=30c8cafa8076b037&ts=935&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=153264&min_rtt=111016&rtt_var=126127&sent=7&recv=5&lost=0&retrans=2&sent_bytes=4312&recv_bytes=710&delivery_rate=7557&cwnd=253&unsent_bytes=0&cid=38dc16f99eee22c7&ts=3331&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1e012e0828dcc5-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2024-12-14T10:44:06.219000\",\n \"updated_at\": \"2024-12-14T10:44:06.219000\",\n \"is_deleted\": false,\n \"meta_data\": null,\n \"uid\": \"a39c5ec8-9d6b-441f-a0f6-e2506662f07c\",\n \"business_name\": \"uFaaS\",\n \"user_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"consumptions\": [\n {\n \"enrollment_id\": \"ca1d528c-75f8-4288-a452-4c0ddd2f01cd\",\n \"amount\": \"43\",\n \"leftover_bundles\": [\n {\n \"asset\": \"internet\",\n \"quota\": \"12288\",\n \"unit\": \"MB\"\n },\n {\n \"asset\": \"phone_call\",\n \"quota\": \"1957\",\n \"unit\": \"minute\"\n },\n {\n \"asset\": \"sms\",\n \"quota\": \"2000\",\n \"unit\": null\n },\n {\n \"asset\": \"credit\",\n \"quota\": \"20000\",\n \"unit\": \"IRR\"\n }\n ]\n }\n ],\n \"asset\": \"phone_call\",\n \"amount\": \"43\",\n \"variant\": null\n}"},{"id":"f7aa9a5f-9282-44ca-acd3-0aa0cf30a228","name":"invalid request","originalRequest":{"method":"GET","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/a39c5ec8-9d6b-441f-a0f6-e2506662f07"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Dec 2024 11:58:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"22"},{"key":"Connection","value":"keep-alive"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=lxZ5TUQNdOXFUyXqjaejaPCBkX7%2B7tIrV0X8XTVC4y7J3tfA8xLHVXFesTezUBc1YccezdIBDH07hIdPGlxNeTRJmx%2FZ%2FwYSr8tjfnFpwhP87IbTsyV7N0ZAiOqDG52A\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=13885&min_rtt=13815&rtt_var=5230&sent=4&recv=6&lost=0&retrans=0&sent_bytes=2830&recv_bytes=1326&delivery_rate=209627&cwnd=98&unsent_bytes=0&cid=e9ae564d2c5a160c&ts=107&x=0\""},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=103655&min_rtt=101204&rtt_var=22973&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2800&recv_bytes=709&delivery_rate=36748&cwnd=252&unsent_bytes=0&cid=ef3f18eae110a88c&ts=377&x=0\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f1e05820c923820-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Not Found\"\n}"}],"_postman_id":"d04a0e4e-c793-4a6f-bd31-28567df6d67d"}],"id":"34fcbca9-0b1d-4152-bbac-a98b39bfcb7d","_postman_id":"34fcbca9-0b1d-4152-bbac-a98b39bfcb7d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}},{"name":"لغو (cancel) یک استفاده مشخص","item":[{"name":"cancel a registered usage","id":"9c86f8a2-148a-4d37-aa8d-b4bdd5e2c458","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{Your_Base_URL}}/api/v1/apps/saas/usages/{uid}/cancel","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}},"urlObject":{"path":["api","v1","apps","saas","usages","{uid}","cancel"],"host":["{{Your_Base_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c86f8a2-148a-4d37-aa8d-b4bdd5e2c458"}],"id":"16345626-a7a9-4032-95bc-81875351740e","description":"چنانچه استفاده‌ای ثبت کردید و متوجه شدید که باید مقدار مصرف به کاربر بازگردد، از این api استفاده می‌کنید.
\nتوجه شود که در صورت پاک شدن موفق یک استفاده ثبت شده، مقدار عبارت is_deleted از false به true تغییر می‌کند و معادل amount آن استفاده، به اشتراک خدمات متناظر، بازگردانده خواهد شد.
تمامی apiهای مربوط به «استفاده» در این بخش قرار دارند. ثبت یک استفاده، مشاهده‌ی استفاده‌های مختلف با فیلترهای مختلف، مشاهده یک استفاده‌ی مشخص و لغو(cancel) کردن یک استفاده.
\n","_postman_id":"0c831275-8c12-42e8-8c73-c8795f355285","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":true,"source":{"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef","id":"afbdc243-ebd8-48e9-962f-85a53261aaef","name":"توضیح APIها","type":"folder"}}}],"id":"afbdc243-ebd8-48e9-962f-85a53261aaef","description":"ابزار ما برای پیاده‌سازی روش‌های درآمدی، APIهای ما هستند.
\nدر ادامه، هر API به همراه نمونه برای اجرا و همچین چندین خروجی نمونه قابل مشاهده است.
\nاحراز هویت با API Key انجام میشود. با قراردادن کلید و مقدار آن در header درخواست، احراز هویت صورت می‌پذیرد.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Enter API token here"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"fc4303f2-fade-4d36-8561-7d1ffc3b34cd","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3992fbbf-ab04-4ebb-812b-fd39d976f90e","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"afbdc243-ebd8-48e9-962f-85a53261aaef"},{"name":"پاسخ به سه سوال اصلی","item":[],"id":"3521ebcd-e8f8-4072-84a7-401da22da329","description":"آیا کاربرم مجاز به استفاده از سرویس است؟
\nبرای کاربرم این میزان مصرف جدید را ثبت کن.
\nمانده موجودی قابل مصرف کاربرم از سرویس من چقدر است؟
\nابتدا برای کاربر یک اشتراک خدمات با بسته‌های مشخص از asset و quota ثبت می‌کنید. (POST Enrollments)
\nدر هر بار تقاضای کاربر برای استفاده، ابتدا از موجودی asset مورد تقاضای کاربر مطمئن شوید.(GET Enrollments)
\nبه ازای هر بار استفاده‌ی کاربر، به میزان استفاده از asset، استفاده ثبت می‌کنید. (Usages)
\nابتدا برای کاربر یک اشتراک دوره‌ای ثبت می‌کنید. (POST Enrollments)
\nدر هر بار تقاضای کاربر برای استفاده، ابتدا از موجودی asset مورد تقاضای کاربر مطمئن شوید.(GET Enrollments)
\nبه صورت اختیاری، به ازای هر بار استفاده‌ی کاربر، به میزان استفاده از asset، استفاده ثبت می‌کنید. (Usages)
\nابتدا برای کاربر یک اشتراک خدمات با بسته‌ای شامل asset برابر اعتبار و quota مقدار اعتبار خریداری شده، ثبت می‌کنید. (POST Enrollments)
\nدر هر بار تقاضای کاربر برای استفاده، ابتدا از موجودی اعتبار کاربر مطمئن شوید.(GET Enrollments)
\nبه ازای هر بار استفاده‌ی کاربر، به میزان استفاده از اعتبار استفاده ثبت می‌کنید. (Usages)
\nابتدا برای کاربر یک اشتراک خدمات با بسته‌ای شامل asset برابر «اعتبار» و با quota برابر مقدار اعتبار سقف قابل پذیرش* خود، ثبت می‌کنید. (POST Enrollments)
* سقف قابل پذیرش مصرف : حداکثر مقدار مصرف قابل پذیرش از جانب شما. مثلا شما به هیچ کسی اجازه نمی‌دهید بیش از ۵۰ گیگابایت ترافیک در ماه استفاده کند چون مطمئن نیستید که بتواند آن را پرداخت کند.
در هر بار تقاضای کاربر برای استفاده، ابتدا با استعلام asset برابر اعتبار و دریافت پاسخ موفق، از مجاز بودن استفاده برای کاربر مطمئن شوید.(GET Enrollments)
اگر کاربر بسته‌ی قرضی (borrowed) با مهلت پرداخت منقضی شده، نداشته باشد و سقف مصرف مجاز مد نظر شما را رد نکرده باشد، پاسخ موفق دریافت میشود.
به ازای هر بار استفاده‌ی کاربر، به میزان استفاده از اعتبار استفاده ثبت می‌کنید. (Usages)
\nهزینه به ازای هر API Call از متد post محاسبه میشود.
\n۱۰۰ درخواست اولیه رایگان برای تست و راه‌اندازی سرویس در این دوره ارائه محدود در اختیار شماست.
\nبه ازای هر API Call از متد post، هزینه ۵۰ تومان است
\nاگر کسب‌وکاری دارید که از مدل‌های درآمدی بالا استفاده می‌کنه، جهت درخواست سرویس فرم زیر را تکمیل کنید:
\n\n","_postman_id":"e4359995-e71c-4cf6-aefe-47514a661231"},{"name":"ارتباط با ما","item":[],"id":"f2c4c26d-ae87-44ce-abb5-a36a33132b83","description":"هر سوالی دارید، من در خدمتم.
\n\nاز وقتی که گذاشتید، سپاسگزارم.
\n","_postman_id":"f2c4c26d-ae87-44ce-abb5-a36a33132b83"}],"event":[{"listen":"prerequest","script":{"id":"99e8314f-d8ab-427c-bf21-52fba3bb06f1","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"36b8445e-4bc2-41da-8926-802aa55b1697","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"x-api-key","value":"Enter API token here","type":"string"},{"key":"base_url","value":"{{Your_Base_URL}}","type":"string"}]}