صدور اعتبار

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

مقدمه

کسب درآمد به شما این امکان را می دهد که اعتبار توسعه دهنده را صادر کنید.

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

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

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

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

صدور اعتبار

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

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

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

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

با استفاده از 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 را مشخص نکنید، اعتبار برای همه محصولات API در بسته محصول API اعمال می شود.

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

برای فهرست کامل پارامترهای پرس و جو که می توانید در درخواست اعتبار مشخص کنید، به پارامترهای Query برای اعتبارات 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

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