Creating an API

Follow the steps below to add an API to the API Store using the API Publisher Web application.

1. Log in to the API Publisher as a user who has the creator role assigned. For more information on creating users and assigning roles, refer to section User Management .
   
   Once logged in, select the Add menu to. The Add New API window opens.
   

   
   

    

   We explain each field of the above window using a sample phone validation service. This service is exposed by Cdyne company, has SOAP and REST interfaces and is documented using a WSDL file. This service is described at : http://wiki.cdyne.com/index.php/Phone_Verification. 

   The table below explains the fields and sample values according to the phone validation service. Only the fields marked with * are mandatory.
    

   Field	Description	Example Values
   Name*	Name of API as you want it to appear in the API store.	PhoneVerification
   Context*	URI context path that is used by to API consumers.	/phoneverify
   Version*	API version (in the form of version.major.minor).	1.0.0
   Description	High-level description of API functionality.	Text
   Visibility	API visibility can be either Public or Restricted. If it is set to Public, the API is visible through the API Store Web application to all API subscribers and also anonymous users of the API store. Alternatively, it can be set to Restricted and specific user roles that have access to the API through the API Store can be set as a comma-separated list (no spaces) in the 'Visible to Roles' text box that appears. Note: If you specify "subscriber" role here, any user who self-subscribes to the API Store will be able to access the API, since users are assigned the "subscriber" role that comes by default with the WSO2 API Manager when they sign-up to the API Store.	Public
   Thumbnail Image	Icon to be displayed in API store (can be jpeg, tiff, png format).	Image file
   Endpoint Type*	Secured endpoint or Non secured endpoint. Default is non secured endpoint. If secured endpoint is selected, user will be asked for credentials of the backend service.	Secured
   Production URL*	Endpoint of the back-end service URL, here: http://ws.cdyne.com/phoneverify/phoneverify.asmx	URL
   Credentials	If secured endpoint is selected as the "Endpoint Type" above, user will be asked for credentials of the backend service.
   Sandbox URL	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.	URL
   WSDL	URL of WSDL file (describing API interface): http://ws.cdyne.com/phoneverify/phoneverify.asmx?wsdl	URL
   WADL	URL to WADL file (describing API interface).	URL
   Tags	Any number of tags separated by comma. Tags allow you to group/categorize APIs that have similar attributes and behaviors. When tagging, always use relevant keywords and common search terms. Once a tagged API gets published to the API Store, its tags appear on the dashboard as links to the API consumers, who can click on them to quickly jump to a category they are interested in.	String
   Tier Availability*	For details, see API-Level Throttling.	Bronze/Gold/Silver/Unlimited
   Business Owner and Email	Information about the person responsible for this API at a business level.	String
   Technical Owner and Email	Information about the person responsible for this API at a technical level.	String
   API Resources	For details, see API Resources.

   
   

   Note

   When the user tries to send requests to a secured endpoint, s/he might get a Hostname verfiication failed exception. To overcome this, set <parameter name="HostnameVerifier"> to AllowAll in <APIM_HOME>/repository/conf/axis2/axis2.xml file's HTTPS transport sender configuration. For example,

   <parameter name="HostnameVerifier">AllowAll</parameter>

   This parameter is used to verifies the hostname of the certificate of a server when API Manager acts as a client and does outbound service calls.

    

2. Once the required information is filled, click the Create button at the end of the page to create the API.
3. If the API is created successfully, the All APIs window opens with the newly-added API. For example,
   
   
4. Click the API to access its information. The following tabs are available:
   
   • 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.
     
   • 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.
     

   Note

   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.

   

Using these tabs, you can manage your API. Next, see Modifying and Deleting an API.