Overview

Oracle TPM RESTful API allows TPM clients to integrate seamlessly between their ERP system and the TPM application. The API provides RESTful web services using JSON payloads.

  • All integration requests are initiated by the client.
  • An active TPM user account is required to use the API.
  • The API requires authentication and all transactions are encrypted.
  • Integration process will vary based on the ERP system and the integration type.
  • Requests are processed asynchronously.

Imports

An integration request that sends data into TPM (e.g., subcontract) is known as an "import" job. An import job is submitted by making a POST request to the TPM API with the data in JSON format. TPM immediately returns a URI. This URI is used to make a GET request. Once the data is processed, the GET request returns the audit response, which provides a detailed summary of the records created, failures, or additional information about the transaction.

Exports

An integration request that retrieves data from TPM (e.g., invoice) is known as an "export" job. An export job is submitted by making a POST request to the TPM API. TPM immediately returns a URI. This URI is used to make a GET request. Once the data is ready in TPM, the GET request returns the data in JSON format.

Accessing the Web Service

The full URL and an import/export example are provided for each endpoint.

Request Header

The request header should contain the following:

Content-Type: application/json

Authorization: Basic {encrypted authentication key}