مدیریت شرکت ها و توسعه دهندگان با استفاده از Edge

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

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

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

  • اگر توسعه دهندگان کسب درآمد شما برای دسترسی به رابط کاربری Edge یا API نیاز به اعتبار ورود دارند، ابتدا باید حساب سرپرست Apigee خود را داشته باشند.
  • اگر به سادگی نیاز به ایجاد برنامه‌نویس‌های آزمایشی دارید که به اعتبارنامه نیازی ندارند (به عنوان مثال، اگر می‌خواهید با برنامه‌نویس‌های آزمایشی ساختگی تماس‌های API برقرار کنید)، هیچ حساب Apigee لازم نیست.

مدیریت توسعه دهندگان برنامه با استفاده از رابط کاربری

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

مدیریت شرکت ها با استفاده از رابط کاربری

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

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

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

لبه

برای دسترسی به صفحه شرکت ها با استفاده از رابط کاربری Edge:

  1. به apigee.com/edge وارد شوید.
  2. انتشار > کسب درآمد > شرکت ها را در نوار پیمایش سمت چپ انتخاب کنید.

صفحه شرکت ها نمایش داده می شود.

همانطور که در شکل مشخص شده است، صفحه شرکت ها شما را قادر می سازد:

Classic Edge (ابر خصوصی)

برای دسترسی به صفحه شرکت ها با استفاده از رابط کاربری Classic Edge:

  1. به http:// ms-ip :9000 وارد شوید، جایی که ms-ip آدرس IP یا نام DNS گره مدیریت سرور است.
  2. در نوار پیمایش بالا ، Publish > Companies را انتخاب کنید.

صفحه شرکت ها نمایش داده می شود.

  • لیست فعلی شرکت ها را مشاهده کنید
  • یک شرکت را مدیریت کنید. به طور خاص یک شرکت را اضافه، فعال، ویرایش و حذف کنید.
  • مشاهده پورتال توسعه دهنده متصل (فقط دروپال 7)

اضافه کردن یک شرکت

برای اضافه کردن یک شرکت:

  1. به صفحه شرکت ها دسترسی پیدا کنید .
  2. روی + شرکت کلیک کنید.
  3. مشخصات شرکت را وارد کنید

    فیلدهای مورد نیاز عبارتند از:

    • نام شرکت
    • مدیر (کاربری که مدیر اصلی شرکت است)
    • نوع صورتحساب

    بسته به پیکربندی صورت‌حساب کسب درآمد، نوع صورت‌حساب ممکن است پیش‌فرض PREPAID یا POSTPAID باشد. برای اطلاعات بیشتر، به پیکربندی انواع صورت‌حساب پیش‌پرداخت و پس‌پرداخت با استفاده از API مراجعه کنید.

  4. یک یا چند توسعه دهنده را به شرکت اضافه کنید.
    1. در قسمت Developers یک رشته را در قسمت Add Developer وارد کنید تا لیست توسعه دهندگان مطابق با رشته نمایش داده شود.
    2. یک توسعه دهنده را از لیست کشویی انتخاب کنید.
    3. برای افزودن توسعه دهندگان اضافی به شرکت، این کار را تکرار کنید.
  5. یک یا چند ویژگی سفارشی اضافه کنید.
    1. در بخش ویژگی های سفارشی، روی + جدید کلیک کنید.
    2. نام و مقدار ویژگی سفارشی را وارد کنید.
    3. برای افزودن ویژگی های سفارشی اضافی به شرکت، این کار را تکرار کنید.
  6. روی ایجاد شرکت کلیک کنید.

فعال و غیرفعال کردن یک شرکت

برای فعال و غیرفعال کردن یک شرکت:

  1. به صفحه شرکت دسترسی پیدا کنید .
  2. مکان نما را روی شرکتی که می خواهید فعال و فعال کنید قرار دهید در منوی اقدامات
    برای غیرفعال کردن شرکت، کلید را غیرفعال کنید.

ویرایش یک شرکت

برای ویرایش یک شرکت:

  1. به صفحه شرکت دسترسی پیدا کنید .
  2. مکان نما را روی شرکتی که می خواهید ویرایش کنید قرار دهید و کلیک کنید در منوی اقدامات
  3. در صورت لزوم، جزئیات شرکت را به روز کنید.
  4. برای ذخیره تغییرات روی Update company کلیک کنید.

حذف یک شرکت

برای حذف یک شرکت:

  1. به صفحه شرکت ها دسترسی پیدا کنید .
  2. مکان نما را روی شرکتی که می خواهید حذف کنید قرار دهید و کلیک کنید در منوی اقدامات
  3. برای تایید عملیات حذف روی Delete کلیک کنید.

مدیریت شرکت ها و توسعه دهندگان با استفاده از API

استفاده از API برای مدیریت شرکت ها و توسعه دهندگان در بخش های زیر توضیح داده شده است.

ایجاد و به روز رسانی شرکت ها و توسعه دهندگان با استفاده از API

برای مدیریت شرکت ها و توسعه دهندگان با API Edge management API، به بخش های API زیر مراجعه کنید:

مدیریت نقش های توسعه دهنده با استفاده از API

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

ایجاد نقش توسعه دهنده

برای ایجاد نقش توسعه‌دهنده، یک درخواست POST برای organizations/{org_name}/developer-roles صادر کنید. هنگام درخواست، باید نام و شرح نقش و هویت سازمان را در بدنه درخواست مشخص کنید. به عنوان مثال:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}" 
   }  
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

بازیابی نقش های توسعه دهنده

برای بازیابی نقش‌های توسعه‌دهنده، یک درخواست GET برای سازمان‌ها/{org_id}/developer-roles صادر کنید. به عنوان مثال:

$ curl -H "Accept:application/json" -X GET \
"https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

پاسخ باید چیزی شبیه به این باشد (فقط بخشی از پاسخ نشان داده شده است):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

تنظیمات پیکربندی نقش توسعه دهنده برای API

گزینه های پیکربندی نقش توسعه دهنده زیر در معرض API قرار می گیرند:

نام توضیحات پیش فرض مورد نیاز؟
name

نام نقش توسعه دهنده.

N/A بله
description

شرح نقش توسعه دهنده

N/A بله

بازیابی نرخ مالیات برای یک توسعه دهنده با استفاده از API

با ارسال درخواست GET به organizations/{org_name}/tax-engine می‌توانید نرخ مالیات فعلی را برای یک برنامه‌نویس دریافت کنید. هنگامی که درخواست را انجام می دهید، باید شناسایی توسعه دهنده را به عنوان پارامتر پرس و جو مشخص کنید. به عنوان مثال:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

پاسخ باید چیزی شبیه به این باشد:

0.09

انجام سایر وظایف خاص توسعه دهنده با استفاده از API

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

جدول زیر وظایف خاص توسعه‌دهنده را فهرست می‌کند که می‌توانید با استفاده از APIهای کسب درآمد انجام دهید. این جدول همچنین فهرستی را نشان می‌دهد که می‌توانید دستورالعمل‌های دقیق در مورد انجام این وظایف را بیابید.

وظیفه جایی که دستورالعمل ها را پیدا کنید
مشاهده شرایط و ضوابط پذیرفته شده توسط یک توسعه دهنده

مشاهده شرایط و ضوابط پذیرفته شده توسط یک توسعه دهنده یا شرکت با استفاده از API

مشاهده بسته های API پذیرفته شده توسط یک توسعه دهنده

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

یک طرح نرخ توسعه دهنده ایجاد کنید

مدیریت برنامه های نرخ

مشاهده طرح‌های نرخ موجود برای یک برنامه‌نویس

کاوش در صفحه طرح های نرخ

مشاهده طرح‌های نرخ موجود برای یک توسعه‌دهنده خاص که حاوی یک محصول خاص است

مشاهده یک طرح نرخ پذیرفته شده برای یک توسعه دهنده که حاوی یک محصول API با استفاده از API است

فقط برنامه‌های نرخ توسعه‌دهنده پذیرفته شده را مشاهده کنید

مشاهده همه طرح‌های نرخ پذیرفته‌شده توسط یک برنامه‌نویس با استفاده از API

صدور اعتبار به یک توسعه دهنده

صدور اعتبار

برای یک توسعه دهنده محدودیت اعتباری تعیین کنید

تنظیم محدودیت اعتبار با استفاده از API

محدودیت اعتبار توسعه دهنده را مشاهده کنید

بازیابی محدودیت اعتبار با استفاده از API

«پر کردن» (مبلغی به) موجودی پیش‌پرداخت برنامه‌نویس

موجودی حساب های پیش پرداخت را مدیریت کنید

موجودی پیش پرداخت توسعه دهنده را مشاهده کنید

مشاهده موجودی حساب های پیش پرداخت برای یک توسعه دهنده

یک شرط اعلان برای یک توسعه دهنده تنظیم کنید

اعلان ها را با استفاده از الگوهای اعلان تنظیم کنید

ایجاد و مشاهده تعاریف گزارش برای یک توسعه دهنده

گزارش ها را مدیریت کنید

،

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

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

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

  • اگر توسعه دهندگان کسب درآمد شما برای دسترسی به رابط کاربری Edge یا API نیاز به اعتبار ورود دارند، ابتدا باید حساب سرپرست Apigee خود را داشته باشند.
  • اگر به سادگی نیاز به ایجاد برنامه‌نویس‌های آزمایشی دارید که به اعتبارنامه نیازی ندارند (به عنوان مثال، اگر می‌خواهید با برنامه‌نویس‌های آزمایشی ساختگی تماس‌های API برقرار کنید)، هیچ حساب Apigee لازم نیست.

مدیریت توسعه دهندگان برنامه با استفاده از رابط کاربری

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

مدیریت شرکت ها با استفاده از رابط کاربری

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

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

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

لبه

برای دسترسی به صفحه شرکت ها با استفاده از رابط کاربری Edge:

  1. به apigee.com/edge وارد شوید.
  2. انتشار > کسب درآمد > شرکت ها را در نوار پیمایش سمت چپ انتخاب کنید.

صفحه شرکت ها نمایش داده می شود.

همانطور که در شکل مشخص شده است، صفحه شرکت ها شما را قادر می سازد:

Classic Edge (ابر خصوصی)

برای دسترسی به صفحه شرکت ها با استفاده از رابط کاربری Classic Edge:

  1. به http:// ms-ip :9000 وارد شوید، جایی که ms-ip آدرس IP یا نام DNS گره مدیریت سرور است.
  2. در نوار پیمایش بالا ، Publish > Companies را انتخاب کنید.

صفحه شرکت ها نمایش داده می شود.

  • لیست فعلی شرکت ها را مشاهده کنید
  • یک شرکت را مدیریت کنید. به طور خاص یک شرکت را اضافه، فعال، ویرایش و حذف کنید.
  • مشاهده پورتال توسعه دهنده متصل (فقط دروپال 7)

اضافه کردن یک شرکت

برای اضافه کردن یک شرکت:

  1. به صفحه شرکت ها دسترسی پیدا کنید .
  2. روی + شرکت کلیک کنید.
  3. مشخصات شرکت را وارد کنید

    فیلدهای مورد نیاز عبارتند از:

    • نام شرکت
    • مدیر (کاربری که مدیر اصلی شرکت است)
    • نوع صورتحساب

    بسته به پیکربندی صورت‌حساب کسب درآمد، نوع صورت‌حساب ممکن است پیش‌فرض PREPAID یا POSTPAID باشد. برای اطلاعات بیشتر، به پیکربندی انواع صورت‌حساب پیش‌پرداخت و پس‌پرداخت با استفاده از API مراجعه کنید.

  4. یک یا چند توسعه دهنده را به شرکت اضافه کنید.
    1. در قسمت Developers یک رشته را در قسمت Add Developer وارد کنید تا لیست توسعه دهندگان مطابق با رشته نمایش داده شود.
    2. یک توسعه دهنده را از لیست کشویی انتخاب کنید.
    3. برای افزودن توسعه دهندگان اضافی به شرکت، این کار را تکرار کنید.
  5. یک یا چند ویژگی سفارشی اضافه کنید.
    1. در بخش ویژگی های سفارشی، روی + جدید کلیک کنید.
    2. نام و مقدار ویژگی سفارشی را وارد کنید.
    3. برای افزودن ویژگی های سفارشی اضافی به شرکت، این کار را تکرار کنید.
  6. روی ایجاد شرکت کلیک کنید.

فعال و غیرفعال کردن یک شرکت

برای فعال و غیرفعال کردن یک شرکت:

  1. به صفحه شرکت دسترسی پیدا کنید .
  2. مکان نما را روی شرکتی که می خواهید فعال و فعال کنید قرار دهید در منوی اقدامات
    برای غیرفعال کردن شرکت، کلید را غیرفعال کنید.

ویرایش یک شرکت

برای ویرایش یک شرکت:

  1. به صفحه شرکت دسترسی پیدا کنید .
  2. مکان نما را روی شرکتی که می خواهید ویرایش کنید قرار دهید و کلیک کنید در منوی اقدامات
  3. در صورت لزوم، جزئیات شرکت را به روز کنید.
  4. برای ذخیره تغییرات روی Update company کلیک کنید.

حذف یک شرکت

برای حذف یک شرکت:

  1. به صفحه شرکت ها دسترسی پیدا کنید .
  2. مکان نما را روی شرکتی که می خواهید حذف کنید قرار دهید و کلیک کنید در منوی اقدامات
  3. برای تایید عملیات حذف روی Delete کلیک کنید.

مدیریت شرکت ها و توسعه دهندگان با استفاده از API

استفاده از API برای مدیریت شرکت ها و توسعه دهندگان در بخش های زیر توضیح داده شده است.

ایجاد و به روز رسانی شرکت ها و توسعه دهندگان با استفاده از API

برای مدیریت شرکت ها و توسعه دهندگان با API Edge management API، به بخش های API زیر مراجعه کنید:

مدیریت نقش های توسعه دهنده با استفاده از API

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

ایجاد نقش توسعه دهنده

برای ایجاد نقش توسعه‌دهنده، یک درخواست POST برای organizations/{org_name}/developer-roles صادر کنید. هنگام درخواست، باید نام و شرح نقش و هویت سازمان را در بدنه درخواست مشخص کنید. به عنوان مثال:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}" 
   }  
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

بازیابی نقش های توسعه دهنده

برای بازیابی نقش‌های توسعه‌دهنده، یک درخواست GET برای سازمان‌ها/{org_id}/developer-roles صادر کنید. به عنوان مثال:

$ curl -H "Accept:application/json" -X GET \
"https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

پاسخ باید چیزی شبیه به این باشد (فقط بخشی از پاسخ نشان داده شده است):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

تنظیمات پیکربندی نقش توسعه دهنده برای API

گزینه های پیکربندی نقش توسعه دهنده زیر در معرض API قرار می گیرند:

نام توضیحات پیش فرض مورد نیاز؟
name

نام نقش توسعه دهنده.

N/A بله
description

شرح نقش توسعه دهنده

N/A بله

بازیابی نرخ مالیات برای یک توسعه دهنده با استفاده از API

می‌توانید با ارسال درخواست GET به organizations/{org_name}/tax-engine نرخ مالیات فعلی را برای یک برنامه‌نویس دریافت کنید. هنگامی که درخواست را انجام می دهید، باید شناسایی توسعه دهنده را به عنوان پارامتر پرس و جو مشخص کنید. به عنوان مثال:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

پاسخ باید چیزی شبیه به این باشد:

0.09

انجام سایر وظایف خاص توسعه دهنده با استفاده از API

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

جدول زیر وظایف خاص توسعه‌دهنده را فهرست می‌کند که می‌توانید با استفاده از APIهای کسب درآمد انجام دهید. این جدول همچنین فهرستی را نشان می‌دهد که می‌توانید دستورالعمل‌های دقیق در مورد انجام این وظایف را بیابید.

وظیفه جایی که دستورالعمل ها را پیدا کنید
مشاهده شرایط و ضوابط پذیرفته شده توسط یک توسعه دهنده

مشاهده شرایط و ضوابط پذیرفته شده توسط یک توسعه دهنده یا شرکت با استفاده از API

بسته های API پذیرفته شده توسط یک توسعه دهنده را مشاهده کنید

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

یک برنامه نرخ توسعه دهنده ایجاد کنید

مدیریت برنامه های نرخ

مشاهده طرح‌های نرخ موجود برای یک برنامه‌نویس

کاوش در صفحه طرح های نرخ

مشاهده طرح‌های نرخ موجود برای یک توسعه‌دهنده خاص که حاوی یک محصول خاص است

مشاهده یک طرح نرخ پذیرفته شده برای یک توسعه دهنده که حاوی یک محصول API با استفاده از API است

فقط طرح‌های نرخ توسعه‌دهنده پذیرفته‌شده را مشاهده کنید

مشاهده همه طرح‌های نرخ پذیرفته‌شده توسط یک برنامه‌نویس با استفاده از API

صدور اعتبار به یک توسعه دهنده

صدور اعتبار

برای یک توسعه دهنده محدودیت اعتباری تعیین کنید

تنظیم محدودیت اعتبار با استفاده از API

محدودیت اعتبار توسعه دهنده را مشاهده کنید

بازیابی محدودیت اعتبار با استفاده از API

«پر کردن» (مبلغی به) موجودی پیش‌پرداخت برنامه‌نویس

موجودی حساب های پیش پرداخت را مدیریت کنید

موجودی پیش پرداخت توسعه دهنده را مشاهده کنید

مشاهده موجودی حساب های پیش پرداخت برای یک توسعه دهنده

یک شرط اعلان برای یک توسعه دهنده تنظیم کنید

اعلان ها را با استفاده از الگوهای اعلان تنظیم کنید

ایجاد و مشاهده تعاریف گزارش برای یک توسعه دهنده

گزارش ها را مدیریت کنید