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

All docs This doc

Versions Compared

Key

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

...

  1. Log in to the management console (https://hostname:9443/carbon) using admin/admin credentials.

  2. Select the Users and Roles menu under the Configure menu.
  3. Click Add New Role and provide creator as the role name.
  4. Click Next.
  5. Select the following permissions from the list that opens and click Finish.
    • Login
    • Manage > API > Create
    • Manage > Resources > Govern and all underlying permissions
  6. Similarly, create the publisher role with the following permissions.


    • Login
    • Manage > API > Publish
  7. You can now create users for each of those roles. To do so, click the Users and Roles menu under the Configure menu.
  8. Click Users.
  9. Click Add New User, provide the username/password and click Next.
  10. Select the role you want to assign to the user (e.g., creator, publisher or subscriber) and click Finish. Given below is a list of usernames and the roles we assign to them in this guide.

    UsernameRole
    apicreatorcreator
    apipublisherpublisher

    Repeat the steps to create at least one user for all roles.

Creating

...

an API

An API creator uses the API provider Web application to create and publish APIs into the API Store. In this section, we explain how to create an API and attach documentation to it.

...

Let's create this API and add it to the API Store.

Creating an API

  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.

    FieldValueDescription
    Name
    PhoneVerification
    Name of API as you want it to appear in the API
    store
    Context
    /phoneverify
    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.
    TransportsSelectHTTP/HTTPS
    Endpoint Security Scheme
    Non-Secured/Secured
    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.
    WSDLURL
    URL of WSDL file (describing API interface) http://ws.cdyne.com/phoneverify/phoneverify.asmx?wsdl
    WADLURLURL to WADL file (describing API interface)

...

The API is now ready to be published. This is done by a user in the publisher role.

Versioning the API

 

Publishing the API

  1. Log in to the API Publisher Web application as apipublisher.
  2. Click on the PhoneVerification API. Note that you can now see a tab as API Lifecycle in the API Publisher UI.
  3. Go to the API Lifecycle tab and select the state as PUBLISHED from the drop-down list.

...