Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • CREATED: API metadata is saved, but it is not visible to subscribers yet, nor deployed to the API Gateway.
  • PROTOTYPED : API is deployed and published in the API Store as a prototype, usually for testing purpose. It is not visible in the API Store. A prototyped API is usually a mock implementation made public in order to get feedback from users about its usability. Users cannot subscribe to a prototyped API. They can only try out its functionality.
  • PUBLISHED: API is visible in API Store, and eventually published if the Propagate Changes to API Gateway option is selected at publishing time.
  • DEPRECATED: API is still deployed into API Gateway (available at runtime to existing users), but not visible to subscribers. An API is automatically deprecated when a new version is published.
  • RETIRED: API is unpublished from the API gateway and deleted from the store.
  • BLOCKED: Access is temporarily blocked. Runtime calls are blocked and the API is not shown in the API store anymore.

...

  1. Log in to the API Publisher (https://<HostName>:9443/store) as a user who has the publisher role assigned. See Managing Users and Roles.
  2. Click on an API that you want to publish.
  3. The API's overview window opens. Click the Life Cycle tab, which displays the API's available states.

    Info
    iconfalse

    The Life Cycle tab is only visible to users with publisher privileges.

  4. To publish the API, select the PUBLISHED state from the drop-down list. You get three check boxes to select as follows:

    Propagate Changes to API Gateway

    Used to define an API proxy in the API Gateway runtime component, allowing the API to be exposed to the consumers via the API Gateway. If this option is left unselected, the API metadata will not change and you will have to manually configure the API Gateway according to the information published in the API Store.

    Deprecate Old Versions

    If selected, any prior versions of the API will be set to the DEPRECATED state automatically.

    Require Re-Subscription

    Invalidates current user subscriptions, forcing users to subscribe again.

  5. Select the necessary options and click the Update button to publish the API to the API Store. 

...

  1. Log in to APIM admin console (https://<Server Host>:9443/carbon) as admin and select Browse menu under Resources .

  2. The Registry opens. G o to /_system/governance/apimgt/externalstores/external-api-stores.xml r esource.

  3. Click the Edit as Text link and change the <ExternalAPIStores> element of each external API store that you need to publish APIs to. For example,

    Code Block
    languagehtml/xml
    <ExternalAPIStores>
            <StoreURL>http://localhost:9763/store</StoreURL>
            <ExternalAPIStore id="Store1" type="wso2">
                <DisplayName>Store1</DisplayName>
                <Endpoint>http://localhost:9763/store</Endpoint>
                <Username>xxxx</Username>
                <Password>xxxx</Password>
            </ExternalAPIStore>
           <ExternalAPIStore id="ProWeb" type="proWeb">
                <Name>ProgrammableWeb</Name>
                <Endpoint>xxxxx</Endpoint>
            </ExternalAPIStore>
            <ExternalAPIStore id="Store2" type="wso2">
                <DisplayName>Store2</DisplayName>
                <Endpoint>http://localhost:9764/store</Endpoint>
                <Username>xxxx</Username>
                <Password>xxxx</Password>
            </ExternalAPIStore>
    </ExternalAPIStores>

    Note the following in the configuration above:

    ElementDescription
    <ExternalAPIStore id=”” "" type=""> id: The external store identifier, which is a unique value.
    type: Type of the Store. APIM 1.5.0 release supports only This can be a WSO2-specific API Stores. Other types will be supported in future releasesStore or an external one.

    <StoreURL>

    URL of the API store of the current APIM deployment. This is the URL to the API in the original publisher's store. APIs that are published to external stores will be redirected to this URL.
    <DisplayName> The name of the Store that is displayed in the publisher UI.

    <Endpoint>

    URL of the API Store.
    <Username> & <Password>

    Credentials of a user who has permissions to create and publish APIs.

    Registry changes are applied dynamically. You do not need to restart the server.

  4. Using the management console, create an API.

  5. Click on the newly created API to see a new tab c alled External API Stores added to the API Publisher console.

    Note the following:

    • You can select multiple external API stores and click Save to publish your API to them. 
    • I f the API creator updates the API after publication to external stores, either the creator or a publisher can simply push those changes to the published stores by selecting the stores and clicking Save again. 
    • If the API creator deletes the API, each external store that it is published to will receive a request to delete the API.
  6. Log in to an external user API store that where the API is published to and note the API advertised in its storefront. Click this APIclick it to open.

  7. A link appears as View Publisher Store and it directs you to the original publisher’s store through which you can subscribe to the API.

...