Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

  1. Open a web browser and access the URL: https://localhost:9443/publisher.
  2. You should see the API Publisher login screen. Type user/password as admin/admin and click Log in button.
  3. The API Provider home page opens with all created APIs listed. Since first-time users haven’t created any APIs so far, they will not see any APIs. Click on the Add button to open the Add New API window. Image Removed
  4. As our first example, we are going to create an API named TestAPI, which is based on the YouTube functionality provided by http://youtube.com. Our API will accept both GET and POST requests and the output will be an Atom feed.

    Enter following values into the respective fields of the Add New API form. In this example, we have not provided some fields which are optional.

    • Name: TestAPI
    • Context: /youtube
    • Version: 1.0.0
    • Visibility: Public
    • Endpoint Security Scheme: Non Secured
    • Production URL: http://youtube.com
    • Tiers Availability
      Anchor
      tiers
      tiers
      : Gold, Silver, Bronze (select all 3 – this field supports multiple values)
  5. Click Create at the end of the form to save the API configuration. You will be taken back to the API Provider home page where the new TestAPI will be listed.
  6. By clicking the TestAPI, you can open its Overview tab, which lists a summary of the information entered when creating the API. The page also has other tabs.

...

  1. To access the API Store, open a web Web browser and type the URL: https://localhost:9443/store. The TestAPI will be listed on the home page itself. Anonymous users also can access this API. To You must log in to subscribe to an API, it is required to log in.
    Image Removed Image Added
  2. Log in to the API Store using the default admin/admin credentials and click on the TestAPI to go to the API overview page. There you should be able (Log in link is in the top right-hand corner of the screen) to see the Subscribe option.
  3. To subscribe to an API, you should have an application in place. Select the DefaultApplication in the Applications drop down.
  4. The Tiers drop down lists all the tiers specified when creating the API. Select the Gold tier and click on the Subscribe button.
    Image Removed Image Added
  5. Choose to proceed to the My Subscriptions page in the pop-up that appears.
    The DefaultApplication will be displayed there along with its subscription to TestAPI. Image Removed
  6. Click the Generate button to obtain a key for your application. You need these access keys to invoke the API.
    Image Removed Image Added

Testing the API

...