صدور اعتبار

شما در حال مشاهده مستندات 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 تعلق می‌گیرد.

برای مثال، درخواست زیر برای ماه آوریل ۲۰۱۸، ۱۰۰ دلار اعتبار برای توسعه‌دهنده‌ای که با شناسه dev1@myorg.com شناسایی شده است، صادر می‌کند. این اعتبار به بسته محصول API payment و طرح نرخ 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 اعتبارات

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