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.
Click the following topics for a description of the concepts that you need to know when creating an API:
The steps below shows you how to create a new API.
- Log in to the API Publisher.
https://<hostname>:9443/publisher
- In the APIS menu, click Add New API.
- Select Design New REST API and click Start Creating.
Give the information in the table below and click Add to add the resource.
Field Sample value Name PhoneVerification Context /phoneverify
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,https://localhost:8243/1.0.0/phoneverify
. Note that the version appears before the context, allowing you to group your APIs based on the versions.Version 1.0.0 Visibility Public Resources URL pattern CheckPhoneNumber
Request types GET, POST
After you add the resource, click it's
GET
method to expand it and update the Produces toapplication/xml
and Consumes toapplication/json
. Next, add the following parameters. You use these parameters to invoke the API using our integrated API Console, which is explained in later tutorials.
Once done, click Next: Implement > .Parameter Name Description Parameter Type Data Type Required PhoneNumber
Give the phone number to be validated Query String True LicenseKey
Give the license key as 0 for testing purpose Query String True
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.Click the Managed API option.
The Implement tab opens. Enter the information in the table below.
Field Sample value Endpoint type HTTP/REST endpoint Production endpoint This sample service has two operations as
CheckPhoneNumber
andCheckPhoneNumbers
. Let's useCheckPhoneNumber
here.
http://ws.cdyne.com/phoneverify/phoneverify.asmxTo verify the URL, click the Test button next to it.
Sandbox endpoint This sample service has two operations as
CheckPhoneNumber
andCheckPhoneNumbers
. Let's useCheckPhoneNumber
here.
http://ws.cdyne.com/phoneverify/phoneverify.asmxTo verify the URL, click the Test button next to it.
Click Next: Manage > and enter the information in the table below.
Field Sample value Description Subscription Tiers Select all The 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. - Click Save & Publish.
This publishes the API that you just created to the API Store so that subscribers can use it. You have created an API.
You can save partially complete or completed APIs without publishing it. Select the API and click on the Lifecycle tab to manage the API Lifecycle.