Try WSO2 Cloud for Free
Sign in

All docs This doc

Versions Compared


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


  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...
    Image Modified 
  4.  Select the option to design a new API and click Start Creating.
    Image Modified
  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}/phoneverifyThe 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 according to versions.

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

    Image Modified

  6. After the resource is added, expand its GET method, add the following parameters. You use them to invoke the API using our integrated API Console 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

    Image Modified

  7. Click the Managed API option.

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

    FieldSample value
    Endpoint typeHTTP endpoint/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.

    Image Modified

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

    FieldSample valueDescription
    Tier AvailabilitySelect allThe API can be available at different level 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.