게시의 첫 번째 작업은 API 제품을 만드는 것입니다. API 제품은 앱 개발자에게 사용하라고 패키지로 제공하는 API 리소스 모음입니다. Apigee API 또는 UI를 사용하여 API 제품을 만듭니다. API 제품에 대한 자세한 내용은 API 제품이란 무엇인가요?를 참조하세요.
이 그림에서 API는 각각 3개의 API 리소스를 포함하는 두 개의 제품으로 구성됩니다.
API 제공업체는 액세스 제어, 사용 제한, 기타 비즈니스 요구사항을 처리하기 위해 API와 API 제품을 빌드할 책임이 있습니다. 예를 들면 다음과 같은 작업을 수행할 수 있습니다.
API 리소스에 대한 읽기 전용 액세스 권한을 허용하는 무료 API 제품을 출시합니다.
무료 버전과 동일한 API 리소스에 대한 읽기/쓰기 액세스를 허용하지만 하루 요청 1,000건으로 액세스 제한이 낮은 두 번째 API 제품을 저렴한 가격으로 출시합니다.
동일한 API 리소스에 대한 읽기/쓰기를 허용하지만 액세스 제한이 높은 세 번째 API 제품을 더 높은 가격으로 출시합니다.
중요한 점은 Apigee가 API의 비즈니스 요구사항과 일치하는 API 제품을 유연하게 만들 수 있다는 것입니다.
개발자가 API를 사용하는 앱을 만듭니다. 앱 개발자는 앱을 등록하기 전에 본인을 Apigee에 등록합니다. 앱을 등록하면 API에 대한 액세스 권한을 앱에 부여하는 API 키가 발송됩니다.
앱 등록 프로세스를 통해 API에 액세스할 수 있는 사용자를 지정할 수 있습니다. 언제든지 앱 개발자를 삭제할 수 있습니다. 삭제하면 개발자와 연결된 모든 API 키가 무효화되어 API에 대한 개발자의 액세스가 거부됩니다.
API 제공업체는 잠재적 개발자를 등록하는 방법을 결정합니다. 예를 들어 잠재적 개발자가 조직에 문의하여 등록해야 하는 수동 등록 프로세스를 사용할 수 있습니다. 잠재적 개발자는 이메일 주소, 이름 등 필요한 모든 정보를 제공해야 합니다. 개발자 요청을 승인하면 Apigee UI를 사용하여 개발자를 직접 등록할 수 있습니다. 자세한 내용은 앱 개발자 등록을 참조하세요.
작업 3: 개발자 앱 등록
앱이 API에 액세스하려면 먼저 앱을 등록해야 합니다. 그러나 등록된 개발자만 앱을 등록할 수 있습니다.
앱을 등록할 때 개발자는 하나 이상의 API 제품을 선택합니다. 예를 들어 다양한 유형의 서비스 및 요금제에 해당하는 여러 API 제품을 게시할 수 있습니다. 그러면 앱 개발자가 사용 가능한 API 제품 목록에서 선택할 수 있습니다.
Apigee에 앱을 등록하면 Apigee는 앱에 고유한 API 키를 할당합니다. 앱은 API 리소스에 대한 모든 요청의 일환으로 API 키를 전달해야 합니다. 키가 인증되고 유효하면 요청이 부여됩니다. 앱이 API에 액세스할 수 없도록 서비스 제공업체가 언제든 키를 취소할 수 있습니다.
API 제공업체는 앱을 등록하는 방법을 결정합니다. 다음과 같은 방법을 사용할 수 있습니다.
수동 프로세스를 사용하여 개발자가 조직에 연락하여 앱을 등록하도록 합니다. 그러면 개발자에게 API 키가 이메일로 전송됩니다.
Apigee API를 사용하여 앱 등록 기능과 키 전달을 웹사이트에 통합합니다.
유료 Apigee 계정의 경우 앱 등록 및 API 키 전송을 기본적으로 지원하는 Apigee 개발자 서비스 포털을 사용합니다.
API 제품 게시 시 중요한 고려사항은 문서 및 개발자 의견 메커니즘을 제공하는 것입니다. 소셜 게시 기능이 있는 개발자 포털은 개발 커뮤니티와의 커뮤니케이션에 점점 더 많이 사용되고 있습니다. 여기에는 정적 콘텐츠(예: API 참고 리소스 및 이용약관)와 동적 커뮤니티 제공 콘텐츠(예: 블로그 및 포럼)와의 커뮤니케이션은 물론 고객 지원 기능이 포함됩니다.
자체 웹사이트를 빌드하여 문서를 배포할 수 있습니다. 유료 Apigee 계정이 있는 경우 Apigee 개발자 서비스 포털을 사용할 수 있습니다. 포털에는 개발자 커뮤니티를 지원하는 데 필요한 문서, 블로그, 포럼, 기타 콘텐츠 유형에 대한 지원 기능이 내장되어 있습니다.
SmartDocs를 사용하면 API 참고 리소스를 완전히 상호작용하게 하는 방식으로 개발자 서비스 포털에서 API를 문서화할 수 있습니다. SmartDocs가 포함된 대화형 문서를 통해 포털 사용자는 다음 작업을 수행할 수 있습니다.
[[["이해하기 쉬움","easyToUnderstand","thumb-up"],["문제가 해결됨","solvedMyProblem","thumb-up"],["기타","otherUp","thumb-up"]],[["이해하기 어려움","hardToUnderstand","thumb-down"],["잘못된 정보 또는 샘플 코드","incorrectInformationOrSampleCode","thumb-down"],["필요한 정보/샘플이 없음","missingTheInformationSamplesINeed","thumb-down"],["번역 문제","translationIssue","thumb-down"],["기타","otherDown","thumb-down"]],["최종 업데이트: 2025-08-18(UTC)"],[[["\u003cp\u003eThis guide explains how to publish APIs using Apigee and Apigee hybrid, focusing on making APIs accessible to app developers.\u003c/p\u003e\n"],["\u003cp\u003ePublishing involves creating API products, which are bundles of API resources packaged for consumption by developers.\u003c/p\u003e\n"],["\u003cp\u003eThe process includes registering app developers, who can then register their apps and receive an API key for accessing the API products.\u003c/p\u003e\n"],["\u003cp\u003eAPI providers can manage access control and usage restrictions by defining API products with different access levels and pricing.\u003c/p\u003e\n"],["\u003cp\u003eProviding clear API documentation and developer support, such as through a developer portal with interactive features like SmartDocs, is crucial for successful API publishing.\u003c/p\u003e\n"]]],[],null,["*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n*Publishing* is the process of making your APIs available to app developers for\nconsumption.\n**Note:** This video was recorded with a previous version of the Apigee UI; however, the concepts are still valid. \n**Video:** The following video provides a high-level introduction to API\npublishing. \n\nPublishing APIs involves the following tasks, described in this topic:\n\n1. Create the API products that bundle your APIs.\n2. Register app developers.\n3. Register developer apps.\n4. Provide documentation and community support for your APIs.\n\nTask 1: Create an API product\n\nThe first task in publishing is to create an API product. An API product is a collection of\nAPI resources that are offered as a package to app developers for consumption. Create API\nproducts by using the Apigee API or UI. (See [What is an API product?](/apigee/docs/api-platform/publish/what-api-product) to learn more about API\nproducts.)\n\nIn this figure, the API consists of two products, each containing three API resources.\n\nAs an API provider, you are responsible for building the APIs and API products to handle\naccess control, usage restrictions, and any other business requirements. For example, you\nmight:\n\n- Release a free API product that allows read-only access to its API resources.\n- Release a second API product for a low price that allows read/write access to the same API resources as the free version but with a low access limit, such as 1000 requests per day.\n- Release a third API product for a higher price that allows read/write access the same API resource but with a high access limit.\n\nThe important thing to remember is that Apigee gives you the flexibility to create API products\nthat match the business requirements of your APIs.\n\nFor more information on creating API products, see [Managing API products](/apigee/docs/api-platform/publish/create-api-products).\n\nTask 2: Register an app developer\n\nA developer creates the apps that consume your APIs. An app developer registers on Apigee\nbefore they can register their app. When they register their app, they receive an API key that\nwill give the app access to the API.\n\nThrough the app registration process, you control who has access to your APIs. At any time,\nyou can delete an app developer, which invalidates all API keys associated with that developer,\ntherefore denying that developer access to your APIs.\n\nAs an API provider, you decide how to register developers. For example, you can use a manual\nregistration process that requires a potential developer to contact your organization to\nregister. The potential developer must supply all necessary information, such as an email\naddress, first and last name. If you approve the developer's request, you\ncan use the Apigee UI to manually register the developer. See [Registering app developers](/apigee/docs/api-platform/publish/adding-developers-your-api-product) for\nmore.\n\nTask 3: Register a developer app\n\nBefore an app can access your APIs, the app must be registered. However, only a\nregistered developer can register an app.\n\nAt the time of app registration, the developer selects one or more API products. For example,\nyou might publish multiple API products corresponding to different types of services and pricing\nplans. The app developer can then pick and choose from the list of available API products.\n| **Note:** Apigee does not require that you to let the developer associate multiple API products with an app. Your publishing plan can be structured such that the developer can select only a single API product. Or, you can automatically assign a default API product to all apps so that the developer does not even get to choose one.\n\nIn response to registering the app on Apigee, Apigee assigns a unique API key to the app. The app\nmust pass that API key as part of every request to an API resource. The key is authenticated and,\nif valid, the request is granted. At any time, you as the service provider can revoke the key so\nthat the app can no longer access your APIs.\n\nAs an API provider, you decide how you want to register apps. You could:\n\n- Use a manual process that requires a developer to contact your organization to register their app. In response, you would send the developer the API key, possibly by email.\n- Use the Apigee API to integrate app registration functionality and key delivery into your website.\n- For a paid Apigee account, use the Apigee Developer Services portal which has built in support for app registration and API key delivery.\n\n| **Note:** As a best practice, there is a 1-1 correlation between the app that the developer registers on Apigee and the actual client app that they build. However, this correlation is not enforced by Apigee. For example, a developer registers a single app on Apigee, associated that app with an API product, and receives back an API key. The developer is free to use the API key from any client app.\n\nFor more information, see [Registering apps and managing API\nkeys](/apigee/docs/api-platform/publish/creating-apps-surface-your-api).\n\nTask 4: Document your APIs\n\nAn important consideration for publishing API products is providing documentation and a\ndeveloper feedback mechanism. Developer portals with social publishing features are increasingly\nbeing used for communication with the development community. This includes communicating static\ncontent, such as API documentation and terms-of-use, as well as dynamic community-contributed\ncontent such as blogs and forums, as well as customer support features.\n\nYou can build your own website to deploy your documentation or, if you have a paid Apigee\naccount, you can use the **Apigee Developer Services portal**. The portal has\nbuilt-in support for documentation, blogs, forums, and other types of content required to support\nyour developer community.\n\n**SmartDocs** lets you document your APIs on the Developer Services portal in a\nway that makes the API documentation fully interactive. Interactive documentation with SmartDocs\nmeans portal users can:\n\n- Read about the API\n- Send a live request to the API\n- View a live response returned from the API\n\nFor more information, refer to the following sections:\n\n- **Integrated portal** : [Publishing your APIs](/apigee/docs/api-platform/publish/portal/publish-apis)\n- **Drupal 10** : [Document your APIs](https://www.drupal.org/docs/8/modules/apigee-edge/document-your-apis)"]]
