صدور اعتبار

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

مقدمه

درآمدزایی به شما انعطاف‌پذیری می‌دهد تا اعتبار توسعه‌دهنده صادر کنید.

برای توسعه‌دهنده پیش‌پرداخت، اعتبار به‌عنوان کاهش در مصرف ظاهر می‌شود — این امر باعث افزایش یا کاهش تراز پیش‌پرداخت توسعه‌دهنده در آینده می‌شود. مشابه استفاده از کارت نقدی، وقتی توسعه‌دهنده بسته محصول API را خریداری می‌کند، وجوه از موجودی پیش‌پرداخت توسعه‌دهنده کسر می‌شود. توسعه‌دهنده باید موجودی کافی برای خریدها داشته باشد. به چگونه تراز باقی‌مانده حساب پیش‌پرداخت را محاسبه کنم؟ مراجعه کنید.

برای توسعه‌دهنده پس‌پرداخت، اعتبار به‌عنوان خطی جداگانه در صورت‌حساب ظاهر می‌شود و هزینه را در صورت‌حساب کاهش می‌دهد.

کاوش صفحه «اعتبارات»

به صفحه «اعتبارات» دسترسی پیدا کنید و آن را کاوش کنید، همان‌طور که در زیر توضیح داده شده است.

صدور اعتبار

1. به صفحه «اعتبارات» دسترسی پیدا کنید.
2. روی + اعتبار کلیک کنید.
3. اطلاعات زیر را وارد کنید:

   فیلد	شرح
   ماه صورت‌حساب	ماه صورت‌حساب که اعتبار در آن اعمال می‌شود. ماهی را از فهرست انتخاب کنید.
   توسعه‌دهنده	نام توسعه‌دهنده یا شرکتی که اعتبار به آن تعلق می‌گیرد. نام را در چارگوش نوشتاری وارد کنید. هم‌زمان با تایپ کردن، فهرستی از توسعه‌دهندگان/شرکت‌هایی که رشته را دربردارند در منوِ کرکره‌ای نشان داده می‌شود. روی نام توسعه‌دهنده یا شرکت از فهرست کرکره‌ای کلیک کنید. توجه: پس‌از انتخاب توسعه‌دهنده یا شرکت، فیلدهای باقی‌مانده نمایش داده می‌شود. اگر شرکت یا توسعه‌دهنده‌ای را انتخاب کنید که طرح نرخ را نپذیرفته است، نمی‌توانید اعتبار صادر کنید.
   دسته محصول	بسته محصول «میانای برنامه‌سازی کاربردی» که اعتبار به آن اعمال می‌شود. از فهرست دسته‌های محصول API دردسترس انتخاب کنید.
   محصول	محصول API در بسته محصول API انتخابی که اعتبار به آن اعمال می‌شود. از فهرست، همه محصولات یا یک محصول API را انتخاب کنید.
   واحد پول	ارز استفاده‌شده برای اعتبار. واحد پول برای طرح نرخ در بسته محصول API که توسعه‌دهنده خریداری کرده است پیکربندی شده است و نمی‌تواند تغییر کند. اگر در طرح نرخ چند ارز تعریف شده باشد، می‌توانید یکی از ارزها را انتخاب کنید.
   مبلغ	مقدار اعتبار (به واحد پول مشخص‌شده). مقدار مثبت یا منفی مشخص کنید. مقدار نمی‌تواند صفر باشد.
   یادداشت	یادداشت اختیاری برای توصیف دلیل اعتبار.

4. روی ذخیره اعتبار کلیک کنید.

صدور اعتبار بااستفاده از API

بااستفاده از API، به توسعه‌دهنده دربرابر بسته محصول API به‌طور کلی، یا دربرابر استفاده از محصول API خاص در بسته محصول API اعتبار بدهید.

برای صدور اعتبار بااستفاده از «میانای برنامه‌سازی کاربردی»، درخواست POST را به /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions ارسال کنید، که در آن {package_id} و {rate-plan_id} به‌ترتیب شناسایی بسته محصول «میانای برنامه‌سازی کاربردی» و طرح قیمت را که اعتبار به آن اعمال می‌شود تعریف می‌کنند.

وقتی درخواست را صادر می‌کنید، باید به‌عنوان پارامترهای پُرسمان مشخص کنید:

• شناسه توسعه‌دهنده (نشانی ایمیل) که اعتبار به او تعلق می‌گیرد.
• مبلغ اعتبار.
• ارز استفاده‌شده برای اعتبار.
• یادداشتی که دلیل اعتبار را توضیح می‌دهد.

درصورت تمایل، می‌توانید پارامترهای پُرسمان اضافی زیر را مشخص کنید:

• ماه صورت‌حساب که اعتبار برای آن اعمال می‌شود. این مقدار به‌طور پیش‌فرض روی ماه جاری تنظیم می‌شود.
• سال صورت‌حسابی که اعتبار برای آن اعمال می‌شود. این مقدار به‌طور پیش‌فرض روی سال جاری تنظیم می‌شود.
• محصول «میانای برنامه‌سازی کاربردی» که اعتبار به آن اعمال می‌شود. اگر شناسه محصول API را مشخص نکنید، اعتبار به همه محصولات API در بسته محصول API اعمال می‌شود.

برای مثال، درخواست زیر اعتباری به مبلغ ۱۰۰ دلار برای ماه صدور صورت‌حساب آوریل ۲۰۱۸ برای توسعه‌دهنده‌ای که با dev1@myorg.com شناسایی شده است صادر می‌کند. اعتبار برای بسته محصول payment API و طرح قیمت payment_standard_plan اعمال می‌شود:

برای مشاهده فهرست کامل پارامترهای پُرسمان که می‌توانید در درخواست اعتبار مشخص کنید، پارامترهای پُرسمان برای API اعتبارها را ببینید.

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

در زیر نمونه‌ای از گزیده پاسخ ارائه شده است:

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

پارامترهای پُرسمان برای «میانای برنامه‌سازی کاربردی اعتبارات»

پارامترهای پُرسمان زیر برای استفاده با API اعتبارات دردسترس است: