Versions Compared

Key

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

...

  1. Ensure that the following prerequisites are satisfied.
    • JDK 1.6.* or higher installed.
    • JAVA_HOME environment variable is set to <JDK_HOME>. For example, JAVA_HOME=c:\/Program Files\/java\/jdk1.6.0_27.
  2. Download the API Manager Binary distribution from http://dist.wso2.org/products/api-manager/1.4.0/wso2am-1.4.0.zip
  3. Extract the zip file to a folder which will be referred to as the <APIM_HOME> throughout the rest of this guide.
  4. Open a command prompt (or a shell in Linux) and go to <PRODUCT_HOME>\/bin directory.
  5. Start the API Manager server by executing wso2server.sh (or wso2server.bat in Windows).
  6. The operation log keep running until the server starts, which usually takes several seconds. Wait until the server has fully booted up and displays a message similar to "WSO2 Carbon started in n seconds."

...

  1. Open a web browser and access the URL: https://localhost:9443/publisher.
  2. You should see the API Publisher log-in login screen. Type user/password as admin/admin and click Login Log in button.
    Image Removed
  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 FindTweetsTestAPI, which is based on the on-line search YouTube functionality provided by Twitter (http://search.twitter.com). Consumers of our FindTweets API will be able to search for Tweets by providing a keyword as the inputyoutube.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: FindTweetsTestAPI
    • Context: /twitteryoutube
    • Version: 1.0.0
    • Appropriate image as the thumbnail
    • EndpointVisibility: Public
    • Endpoint Security Scheme: Non Secured
    • Production URL: http://search.twitteryoutube.com
    • Tiers Availability
      Anchor
      tiers
      tiers
      : Gold, Silver, Bronze (select all 3 – this field supports multiple values)
    • Business owner: Bruce Wayne
    • Business owner e-mail: dark.knight@wayne-enterprises.com
    • Technical owner: Peter Parker
    • Technical owner e-mail: spidey@dailybugle.com

    Image Removed

    Click the Create button
    • Image Added
  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 FindTweets API TestAPI will be listed.
  6. By clicking the FindTweet APITestAPI, you can open its Overview tab, which lists a summary of the information entered when creating the API. The page also has other tabs.
    Image Removed Image Added

Publishing the API

...

  1. To publish the API, select the Life Cycle tab where you will see a drop down with different states the API can be in.
    Image Removed
  2. Select the PUBLISHED state in the drop down and click the Update button to apply the state change. The API Provider immediately displays the API state as PUBLISHED.

    Image Added

Subscribing to the API as a consumer

...

  1. To access the API Store, open a web Web browser and type the URL: https://localhost:9443/store. The FindTweets API 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 FindTweets API to go to the API overview page. There you should be able to (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.
  6. The DefaultApplication will be displayed there along with its subscription to the FindTweets API.
    Image Removed
  7. 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

Any REST client can be used to invoke the FindTweets APITestAPI. For Curl, use the following command to invoke the FindTweets APIit.

curl -v -H "Authorization: Bearer xxxxx" http://localhost:8280/twitteryoutube/1.0.0/search.atom?q=wso2most_popular
Replace the 'xxxx' with the application key obtained earlier. If the right key is passed, the API Manager will route the call to 'search.twitteryoutube.com' and get you an Atom feed consisting of all the recent Tweets tagged with the keyword 'wso2'.the results. You can similarly access various other feeds in the YouTube API by changing the last segment of the invoked URL. For example, http://localhost:8280/youtube/1.0.0/top_rated, http://localhost:8280/youtube/1.0.0/most-shared etc.
You now have an introductory understanding of how to create and publish APIs through the API Publisher Web application, and how API consumers can use the API Store to subscribe to an API and invoke it. The proceeding chapters of this documentation provide detailed information on the API Manager, its components along with samples and tutorials.