Copyright © TIBCO Software Inc. All Rights Reserved

Creating an API and API Operations

Creating an API

Actor: Portal Administrator

To create an API:

1.	Log in to the API Manager Portal as a portal administrator.

2.	Select the APIs tab and click Create New API.

The Create New API page appears.

3.	Enter the information to define the API:

−	API name  Enter a name for the API.

−	Description  Enter description for the API.

−	API Type  Choose the API type from the options in the drop-down list: REST and SOAP. The default API type is REST.

4.	Upload the API spec and documentation for the API:

Specification artifacts must be available for upload.

a.	Upload REST API Spec  If the API is a REST API, to add a REST API specification, click Add files, and then browse for and select the Swagger specification files to be added. Ensure that the file format is JSON. Once the files are selected, click Start upload to upload the selected files.

b.	Upload WSDL API Spec  If the API is a SOAP API, to add WSDL API specification, click Add files, and then browse for and select the WSDL specification files to be added. Once the files are selected, click Start upload to upload the selected files.

c.	REST resource path  Enter the REST resource path for the REST API.This field is applicable to REST APIs and can be left empty for APIs of type SOAP.

 

The REST API resource paths specified must be unique for a product. Specifying duplicate resource paths may result in the swagger specifications being displayed incorrectly in the API explorer.

d.	Environments  Click Choose and select one or more environments in which the APIs are provisioned and are usable.

5.	Enter information for the API documentation:

−	Attached Documentation Files  Click Add files to add one or more documentation files for the API and then click Start upload to upload the selected files.

−	Inline documentation  Enter inline documentation text as required.

6.	Click Save.

An API detail page for the new API appears. This page shows the API specification, Description, API type, and resource path for the API.

7.	Specify the following information.

−	Contact  Contact for the API. Click Create New to create a new contact or click Choose and choose the contact for the API.

−	Owner organization  Name of the organization that owns the API. The value is assigned automatically.

−	Contained in products  Click Choose, and then from the list of products, choose the products that will use the API.

−	Operations  Operations can be added to the API after the API is created. Depending on the type of the API, the portal administrator might need to add operations to the newly created API:

For REST APIs, the operations are picked up from the specification and automatically added to the API. However, the operations are not picked up from the specification for SOAP APIs. The portal administrator must manually add operations to the SOAP APIs after creating them.

See Adding an Operation for details.

Adding an Operation

Actor: Portal Administrator

To add an operation:

1.	Log in to the API Manager Portal as a portal administrator.

2.	Select the APIs tab and then select an existing API. The API details page appears.

3.	Under the Operations section, click Add Operation.

The Create New Operation interface appears.

4.	Enter the information to identify the operation:

−	Operation name  Enter a name for the operation.

−	Description  Enter description for the operation.

−	URI path  Enter the REST operation's path or the endpoint URI for the WSDL.

−	REST method  Select a method for the REST operation from the drop-down: DELETE, GET, POST, or PUT.

−	SOAP Action  If the API is a SOAP API, enter the SOAP action for the SOAP operation.

5.	Click Save to add the operation to the API.

 

Copyright © TIBCO Software Inc. All Rights Reserved