Managing APIs

An API is an artifact type which is implemented as a Configurable Governance Artifact. It can be published to an Artifact Store which is defined to perform a particular task.

Adding an API

Follow the instructions below to add a new API to the Governance Registry.

1. Sign in. Enter your user name and password to log on to the Management Console.
   
2. Click Main > Metadata > Add > API.
   

3. On the Add API page, specify the following options:
   
   

   Field	Description
   Provider	The name of the provider of API
   Name	Name of API as it is should be displayed
   Context	URI context path that is used by consumers (E.g. - /phoneverify)
   Version	The version of the API (in the form of version.major.minor) (E.g. - 1.0.0)
   Description	High-level description of API functionality.
   Endpoint URL	Endpoint of the back-end service URL (E.g. - http://ws.cdyne.com/phoneverify/phoneverify.asmx)
   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.
   WSDL	URL of WSDL file.
   WADL	URL of WADL file.
   Thumbnail	Icon to be displayed (can be jpeg, tiff, png format).
   Tier Availability	Tiers represents different levels of services, a user has to specify a tier to create an API.
   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

4. An API is made up of one or more resources. Each resource handles a particular type of requests. A resource is analogous to a method (function) in a larger API. A URI template should be defined for an API resources which is a compact sequence of characters for describing a range of Uniform Resource Identifiers through variable expansion (E.g. /phoneverify/{phoneNumber}). 
   
   The URI template should be defined as in http://tools.ietf.org/html/rfc6570
    

Listing APIs

Follow the instructions below to list out the APIs in Governance Registry. 

1. Click Main > Metadata > List > APIs.
   
2. It is possible to view APIs by filtering as required.