Follow the steps below to create an API:
...
| Child pages (Children Display) |
|---|
...
General details
...
Default version
...
All API contexts are suffixed with an API version. The default version option allows you to mark one API, from a group of API versions, as the default one, so that it can be invoked without specifying the version number in the URL. For example, say that the following API versions exist:
If you mark the third API as the default API, requests made to http://host:port/youtube/ get automatically routed to http://host:port/youtube/3.0.
You can make any of the API versions as the default version at any time. However, if you mark an unpublished API as the default while the previously default API was a published one, then the users who invoke the default API will still be routed to the previous default version rather than the new one. This is because the new default API version is not published yet.
...
Transports*
...
The transport protocol on which the API is exposed. Both HTTP and HTTPS transports are selected by default. If you want to limit API availability to only one transport (e.g., HTTPS), un-check the other transport.
...
- collector
- true - Specifies that the mediator instance is a response collection instance.
- false - Specifies that it's a cache serving instance.
- collector
...
- max MessageSize - Specifies the maximum size of a message to be cached in bytes. An optional attribute, with the default value as
unlimited. - maxSize - Defines the maximum number of elements to be cached.
- max MessageSize - Specifies the maximum size of a message to be cached in bytes. An optional attribute, with the default value as
...
Icon to be displayed in API store (can be jpeg, tiff, png format)
...
API resources
...
Click Implement and provide implementation details as follows:
| Implementation method |
Endpoints
...
An endpoint defines the external destination for an outgoing message. WSO2 API Manager has support for a range of different endpoint types allowing the API Gateway to connect with advanced types of backends. The API Manager supports HTTP endpoints, URL endpoints (also termed as address endpoint), WSDL endpoints, Failover endpoints, Load-balanced endpoints.
Also see Adding an Endpoint section in the ESB docs for details of the advanced configuration options.
...
Also see Maintaining Separate Production and Sandbox Gateways.
| Info |
|---|
The system reads gateway endpoints from
If both types of endpoints are defined, the HTTPS endpoint will be picked as the server endpoint. |
| Info |
|---|
You cannot call back-end services secured with OAuth through APIs created in the API Manager. At the moment, you can call only services secured with username/password. |
| Excerpt | ||
|---|---|---|
| ||
Added in FAQ space: http://docs.wso2.org/display/FAQ/APIM+Common#APIMCommon-Isitpossibletocallback-endservicessecuredwithOAuththroughAPIscreatedinAPIManager |
| Info |
|---|
The API Manager allows you to expose both REST and SOAP services to consumers through APIs. |
...
Secured endpoint or Non secured endpoint. Default is non secured endpoint.
If secured endpoint is selected, user is asked for credentials of the backend service.
| Note |
|---|
If you get a This parameter verifies the hostname of the certificate of a server when API Manager acts as a client and does outbound service calls. |
...
URL of WSDL file describing API interface. (E.g., http://ws.cdyne.com/phoneverify/phoneverify.asmx?wsdl )
| Info |
|---|
When you provide the WSDL URL, the WSDL content will be saved as a resource file under |
...
Enable this feature to generate a graph showing the number of times an API accesses its destination addresses. This graph is generated in the API Manager Statistics dashboard . It gives API Publishers an insight about the requests that leave the Gateway to destination endpoints, especially useful in cases where the same API can reach different endpoints (e.g., Load-balanced endpoints).
...
Business information
| Field | Description |
|---|---|
Business Owner and Email | Information about the person responsible for this API at a business level. |
Technical Owner and Email | Information about the person responsible for this API at a technical level. |
Subscriptions
| Field | Description |
|---|---|
| Subscriptions | Used to specify the tenants who can subscribe to an API, in a multi-tenanted API Manager deployment. The following types of subscription categories are available between tenants:
|
...
Once the required information is filled, click the Create button at the end of the page to create the API.
...
If the API is created successfully, the All APIs window opens with the newly-added API.
...
Click on the API's name to open its information in the following tabs: 
- Overview: Displays the details of the API
Edit: Allows the user to change the API details and test the Endpoint URL, Sandbox URL, WSDL and WADL.
Info The Edit tab is only visible to users with creator privileges. Users logged in as creators do not have permission to publish the API. To publish, you need to log in as a user with publisher privileges.
- Versions: Shows usage and subscription statistics of the API per version.
- Docs: Allows to add documents to an API. For instructions, refer to section Adding Documentation Using API Publisher.
- Users: Shows the list of active users subscribed to the API and their subscription statistics.
Using these tabs, you can manage your API. Next, see Modifying and Deleting an API.The following sections walk you through creating, implementing and managing an API:
| Child pages (Children Display) |
|---|