x

JSON API uses the same Application logic that is available through the TPM user interface. That means the same transaction, pooling, and caching are available and can be using in conjunction with the TPM user interface.

When using TPM user interface and JSON API it is recommended that separate ports to be used for each service.

Notes:

• JSON API is not recommended for getting data in iSM. For getting TPM data in iSM, use runtime or custom functions provided by TPM.
• When using JSON API, no end user authentication is performed and all authentication issues should be dealt with by the client using JSON API.

TPM JSON API is available for the following domains:

• Partner
  • Contact
  • PartnerSystem
• System
• Routes
• MetaData
• Standards
• Message
• Environments

API supports HTTP Post only and shares a common URL, which is http://servername:8089/do? (Note: "?" is required). All API have two common parameters, action and subaction. Action determines the domain (like partner, system, metadata, standards, routes etc.) and subaction determines the action to be performed within the subaction. For example, for getting a list of all partners the URL would be http://servername:8089 /do?, action would be partner, and subaction would be getpartner. To get a list of all routes the URL would be http://servername:8089 /do?, action would be routes, and subaction would be getroutes.

API operations, input parameters, and output parameters are in lowercase by default and are case sensitive.

API is stateless and the client responsibility is to maintain an end user state by sending proper parameters in each call.

With these concepts in mind let us look at each API in more detail.