WSO2 API Cloud documentation is getting a whole new look at
Try WSO2 Cloud for Free
Sign in

All docs This doc
Skip to end of metadata
Go to start of metadata

API creation is the process of linking an existing backend API implementation to the API Publisher so that you can manage and monitor the API's lifecycle, documentation, security, community, and subscriptions. Alternatively, you can provide the API implementation in-line in the API Publisher itself.

In this tutorial , you create an API using a production endpoint and publish it to the API Store.

Click the following topics for a description of the concepts that you need to know when creating an API:

Let's get started. See the video tutorial here or a step-by-step walk-through of the video tutorial below.

Here's a step-by-step walk-though of the video tutorial:

  1. If you have not registered to the API Cloud yet, go to and sign up. 
  2. Log in to the API Cloud and the API Publisher Web application will open automatically.
  3. Close the interactive tutorial that starts automatically if you are a first-time user, and then click New API...
  4.  Select the option to design a new API and click Start Creating .
  5. Give the information in the table below and click Add to add the resource.

    FieldSample value


    Tip: You can define the API's version as a parameter of its context by adding the {version} into the context. For example, {version}/phoneverify. The API Manager assigns the actual version of the API to the {version} parameter internally. For example, Note that the version appears before the context, allowing you to group your APIs based on to versions.

    • URL Pattern: CheckPhoneNumber
    • Request Types: GET, POST

  6. After you add the resource, click its GET method to expand it, add the following parameters. You use them to invoke the API using our integrated API Console, which is explained in later tutorials. Once done, click Implement.

    Parameter NameDescriptionParameter TypeData TypeRequired
    PhoneNumberGive the phone number to be validatedQueryStringTrue
    LicenseKeyGive the license key as 0 for testing purposeQueryStringTrue

    Alternatively, click Save to save all the changes made to the API. You can come back later to edit it further by selecting the API and clicking on Edit. For details about the states of the API see Manage the API Lifecycle.
  7. Click the Managed API option.

  8. The Implement tab opens. Enter the information in the table below.

    FieldSample value
    Endpoint typeHTTP/REST Endpoint
    Production endpoint

    This sample service has two operations as CheckPhoneNumber and CheckPhoneNumbers. Let's use CheckPhoneNumber here.

    To verify the URL, click the Test button next to it.

  9. Click Manage to go to the Manage tab and enter the information in the table below.

    FieldSample valueDescription
    Tier AvailabilitySelect allThe API can be available at different levels of service. They allow you to limit the number of successful hits to an API during a given period of time.

  10. Click Save & Publish. This will publish the API that you just created in the API Store so that subscribers can use it. You can save the API without publishing it. Select the API and click the Lifecycle tab to manage the API Lifecycle.

You have created an API.

For details on creating APIs using Swagger definitions, see Create APIs using a Swagger URL.

  • No labels