نمای کلی انتشار

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

انتشار فرآیندی است که در آن API های شما برای مصرف در اختیار توسعه دهندگان برنامه قرار می گیرد.

انتشار APIها شامل وظایف زیر است که در این مبحث توضیح داده شده است:

1. محصولات API را در Edge ایجاد کنید که APIهای شما را با هم ترکیب می کنند.
2. توسعه دهندگان برنامه را در Edge ثبت کنید.
3. برنامه های توسعه دهنده را در Edge ثبت کنید.
4. اسناد و پشتیبانی جامعه را برای API های خود ارائه دهید.

وظیفه 1: یک محصول API در Edge ایجاد کنید

اولین وظیفه در انتشار، ایجاد یک محصول API است. محصول API مجموعه ای از منابع API است که به عنوان یک بسته به توسعه دهندگان برنامه برای مصرف ارائه می شود. محصولات API را با استفاده از API یا UI مدیریت Edge ایجاد کنید. (برای کسب اطلاعات بیشتر در مورد محصولات API ، محصول API چیست؟ )

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

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

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

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

برای اطلاعات بیشتر در مورد ایجاد محصولات API، به ایجاد محصولات API مراجعه کنید.

وظیفه 2: یک توسعه دهنده برنامه را در Edge ثبت کنید

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

از طریق فرآیند ثبت برنامه، شما کنترل می کنید که چه کسی به API های شما دسترسی دارد. در هر زمان، می‌توانید یک برنامه‌نویس را حذف کنید، که همه کلیدهای API مرتبط با آن برنامه‌نویس را باطل می‌کند، بنابراین دسترسی آن برنامه‌نویس به APIهای شما را ممنوع می‌کند.

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

Apigee همچنین ابزارهایی را ارائه می دهد که می توانید از آنها برای خودکار کردن فرآیند ثبت نام توسعه دهندگان استفاده کنید. به عنوان مثال:

• از API مدیریت Apigee Edge برای ادغام قابلیت ثبت در وب سایت موجود خود استفاده کنید. API مدیریت Edge یک API REST است که می توانید از آن برای انجام تمام جنبه های فرآیند ثبت نام توسعه دهنده استفاده کنید. برای اطلاعات بیشتر به استفاده از API مدیریت Edge برای انتشار APIها مراجعه کنید.
• برای ثبت نام توسعه دهندگان از پورتال Apigee Developer Services استفاده کنید. پورتال دارای پشتیبانی داخلی برای ثبت نام توسعه دهنده است، اما همچنین دارای بسیاری از ویژگی های دیگر برای پشتیبانی از API های شما است. ببینید پورتال توسعه دهنده چیست؟ برای بیشتر

وظیفه 3: یک برنامه توسعه دهنده را در Edge ثبت کنید

قبل از اینکه یک برنامه بتواند به API های شما دسترسی داشته باشد، برنامه باید در Edge ثبت شود. با این حال، فقط یک توسعه دهنده ثبت نام شده می تواند یک برنامه را در Edge ثبت کند.

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

در پاسخ به ثبت برنامه در Edge، Edge یک کلید API منحصر به فرد را به برنامه اختصاص می دهد. برنامه باید آن کلید API را به عنوان بخشی از هر درخواست به یک منبع API ارسال کند. کلید احراز هویت می شود و در صورت معتبر بودن، درخواست پذیرفته می شود. در هر زمان، شما به‌عنوان ارائه‌دهنده خدمات می‌توانید کلید را لغو کنید تا برنامه دیگر نتواند به APIهای شما دسترسی داشته باشد.

به عنوان یک ارائه دهنده API، شما تصمیم می گیرید که چگونه می خواهید برنامه ها را ثبت کنید. شما می توانید:

• از یک فرآیند دستی استفاده کنید که به توسعه‌دهنده نیاز دارد تا با سازمان شما تماس بگیرد تا برنامه خود را ثبت کند. در پاسخ، احتمالاً از طریق ایمیل، کلید API را برای توسعه‌دهنده ارسال می‌کنید.
• از API مدیریت Edge برای ادغام قابلیت ثبت برنامه و تحویل کلید در وب سایت خود استفاده کنید.
• برای یک حساب Edge پولی، از پورتال Apigee Developer Services استفاده کنید که از ثبت برنامه و تحویل کلید API پشتیبانی می کند.

برای اطلاعات بیشتر، به ثبت برنامه‌ها و مدیریت کلیدهای API مراجعه کنید.

وظیفه 4: API های خود را مستند کنید

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

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

SmartDocs به شما امکان می دهد API های خود را در پورتال خدمات توسعه دهنده به گونه ای مستند کنید که اسناد API را کاملاً تعاملی کند. اسناد تعاملی با SmartDocs به این معنی است که کاربران پورتال می توانند:

• در مورد API بخوانید
• یک درخواست زنده به API ارسال کنید
• مشاهده پاسخ زنده برگشتی از API

به عنوان مثال، شکل زیر یک API مستند شده در پورتال با استفاده از SmartDocs را نشان می دهد. این API اطلاعات آب و هوا را برای یک مکان خاص ارائه می دهد:

توسعه‌دهنده مقداری را برای پارامتر query 'w' وارد می‌کند تا مکان را مشخص کند، و سپس روی دکمه Send the request کلیک می‌کند تا درخواست و پاسخ زنده را ببیند. با ایجاد یک مستندات تعاملی روی API های خود، یادگیری، آزمایش و ارزیابی API های خود را برای کاربران پورتال آسان می کنید.

API مدیریت Edge یک API REST است که به شما امکان می دهد با استفاده از هر مشتری HTTP به خدمات API دسترسی داشته باشید. Apigee از SmartDocs برای ایجاد اسناد تعاملی برای API مدیریت Edge استفاده می کند. اسناد API را اینجا ببینید.

برای اطلاعات بیشتر، استفاده از SmartDocs برای مستندسازی APIها را ببینید.