This documentation is for WSO2 API Manager 1.7.0 View documentation for the latest release.
Page Comparison - Quick Start (v.28 vs v.29) - API Manager 1.7.0 - WSO2 Documentation

All docs This doc

Versions Compared


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


  1. Open the API Publisher (https://<YourHostName>:9443/publisher) and log in as apicreator.
  2. Click the Add link and provide the mandatory information, as described in the table below, to your API.

    Name of API as you want it to appear in the API
    URI context path that is used by to API consumers
    Version1.0.0API version (in the form of version.major.minor)
    Tier AvailabilityBronze/Gold/Silver/UnlimitedThe API can be available at different level of service; you can select multiple entries from the list. At subscription time, the consumer chooses which tier they are interested in.
    Endpoint Security Scheme
    If the back-end service is a secured service, select 'Secured' and enter the credentials for secured service in appearing text boxes. Else keep as Non-Secured.
    Endpoint TypeSelect
    Endpoint Type. E.g., High available and load balanced endpoints
    Production EndpointURL
    Endpoint of the back-end service URL, here:
    Sandbox EndpointURL
    Endpoint of sandbox (testing) back end service. A sandbox URL is meant to be used for online testing of an API with easy access to an API key.
    URL of WSDL file (describing API interface)
    WADLURLURL to WADL file (describing API interface)
    Adding API resources

    An API is made up of one or more resources. Each resource handles a particular type of requests. A resource is analogous to a method (function) in a larger API.

    API resources accept following attributes:

    • Scope:
    • Verbs: HTTP verbs a particular resource accepts. Allowed values are GET, POST, PUT, DELETE. Multiple values can be specified.
    • URL pattern: URI template as defined in E.g., /phoneverify/{phoneNumber}
    • Auth type: Resource level authentication along HTTP verbs. Can be one of the following:
      • None : Can access the API resource without any access tokens
      • Application: Application access token is required to access the API resource
      • Application User: User access token is required to access the API resource

    Once a request is accepted by a resource, it is mediated through an in-sequence. Any response from the backend is handled through the out-sequence. Fault sequences are used to mediate errors that might occur in either in or our sequences. Default in-sequence, out-sequence and fault sequence are generated when the API is published.

    Adding documentation
  3. After creating the API, click on its icon to open its details. Select the Docs tab, For example,
    Image Removed.

  4. Click Add New Document link. Image Added

    Documentation can be provided inline, via a URL or as a file. For inline documentation, you can edit the content directly from the API publisher interface. You get several documents types:
    • Swagger documents
    • How To
    • Samples and SDK
    • Public forum / Support forum (external link only)
    • API message formats
    • Other
  5. Select the How To type, a name for the document and a short description, which will appear in the API Store. Select inline or provide a URL.
  6. Click Add Document.
  7. Once the document is added, click Edit Content link, which opens an embedded editor to edit the document contents.


  8. as