Creating an API
To create APIs in an organization, you must have the Create Assets permission or Manage Assets permission for that organization. For more information about roles and permissions, see Getting Started with CentraSite.
To create an API
1. In CentraSite Business UI, click the Create Asset activity. This opens the Create a New Asset wizard.
2. In Basic Information profile, specify the following fields:
In this field... | Do the following... |
Name | Mandatory. Enter a name for the API. An API name can contain any character (including spaces). An API name does not need to be unique within the catalog. However, to reduce ambiguity, you should avoid giving multiple APIs of the same type the same name. As a best practice, we recommend that you adopt appropriate naming conventions to ensure that APIs are distinctly named within an organization. |
Type | Choose the type of API that you want to create in the catalog. The APIs that are supported out-of-the-box are: Service, REST service, XML Service, Virtual Service, Virtual XML Service, and Virtual REST Service. |
Organization | Choose the organization in which the API will be created. (The drop-down list will contain the list of organizations in which you are permitted to create APIs.) If you select an organization other than your own organization, you will nevertheless be the owner of the API. |
Version | Optional. Enter an identifier for the initial version of the API. This is the user-defined version, as opposed to the automatically assigned system version. You can enter any string in this field, i.e. the version identifier does not need to be numeric. You can also leave the field blank. You can later create new versions of the API. |
Description | Optional. Enter a comment or descriptive information about the API. |
URL or File | Specify whether the input file will be read from your local file system (the File option) or from a URL-addressable location on the network (the URL option). If the file you are importing resides on the network, specify its URL. If the file resides in your local file system, specify the file name. You can use the Browse button to navigate to the required folder. |
3. Expand the Advanced Settings node. Enter the following information:
In this field... | Do the following... |
Credentials | If you have specified a URL, and the site you want to access via the URL requires user authentication, enter a username and password for authentication at the URL site. |
Resolution | Choose a resolution strategy, which will allow you to specify how an already existing imported/included file is handled. For each of the imported/included files you have one of these options:  Overwrite the importing file with new content. Create a new version of the file with the new content (if, for example, you want to modify a WSDL file but want to retain its previous version). |
4. Click Next.
You will not be allowed to move to the next panel unless all of its required parameters have been set.
5. In the Preview panel, review the basic information for API before you actually add to CentraSite.
If necessary, you can click Previous to return to the Basic Information profile and change your specifications.
6. Click Save.
An API asset instance is created in the specified organization and added to the CentraSiteregistry/repository. The asset details page for the API that you just created is displayed.
