[[["容易理解","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 (世界標準時間)。"],[[["\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)"]]
