Connecting to SAP CPI

Creating an API Service Key for CPI Transporter

This guide explains how to create the necessary Service Key in your SAP BTP subaccount. This key allows the CPI Transporter to access and manage your integration artifacts using the API plan of the „Process Integration Runtime“ service.

To enable CPI Transporter to deploy and manage integration artifacts, you need a Service Instance of „Process Integration Runtime“ with the „api“ plan, and a Service Key for that instance.

Step 1: Log in to your SAP BTP Cockpit.
Navigate to the Subaccount where your Cloud Integration service is enabled.
Step 2: Navigate to Service Marketplace.
In your Subaccount, go to Services → Service Marketplace and search for „Process Integration Runtime“.
Step 3: Create a new instance.
Click Create on the „Process Integration Runtime“ tile.
It is recommended to create a new, dedicated instance for CPI Transporter for clear permission separation, even if other instances exist.
Step 4: Configure the new instance.
Service
Process Integration Runtime
Plan
api
Instance Name
CPITransporter_API_Access
The plan must be „api“
The integration-flow plan is for runtime message processing and will not work for deployment via CPI Transporter.
5
Step 5: Assign roles (permissions for API access).
- WorkspacePackagesEditAllows editing of integration packages.
- WorkspacePackagesConfigureAllows configuration of integration packages.
- WorkspaceArtifactsDeployAllows deployment of integration artifacts (IFlows, Value Mappings, etc.).
- AccessAllAccessPoliciesArtifactsRequired for managing access policies related to artifacts.
- MonitoringDataReadAllows reading of monitoring data, which is used for connection tests and status checks.
Instance parameters (JSON)
```
{
  "roles": [
    "WorkspacePackagesEdit",
    "WorkspacePackagesConfigure",
    "WorkspaceArtifactsDeploy",
    "AccessAllAccessPoliciesArtifacts",
    "MonitoringDataRead"
  ]
}
```
Step 6: Create the Service Key.
Open the instance under Instances and Subscriptions, then choose … → Create Service Key.
Step 7: Configure the Service Key.
Give it a name, for exampleCPITransporter_API_Key
8
Step 8: Copy the credentials.
- url — design-time API endpoint, e.g. https://your-tenant-tmn.hci.<region>.hana.ondemand.com
- clientid — becomes the username in CPI Transporter
- clientsecret — becomes the password
- tokenurl — e.g. https://yoursubaccount.authentication.<region>.hana.ondemand.com/oauth/token
What the Service Key looks like
```
{
  "oauth": {
    "clientid": "sb-abcd1234!b12345|it-rt-your-subaccount!b12345",
    "clientsecret": "aBcDeF...=",
    "url": "https://yoursubaccount.authentication.eu10.hana.ondemand.com",
    "tokenurl": "https://yoursubaccount.authentication.eu10.hana.ondemand.com/oauth/token"
  },
  "url": "https://your-tenant-tmn.hci.eu10.hana.ondemand.com"
}
```
Tip: skip the typing
Copy the entire JSON output and paste it into Quick Fill with Service Key JSON when adding a system — URL, ClientID, ClientSecret and token URL are filled in for you. The JSON is parsed in your browser and never sent anywhere.

That's it

By following these steps, you create a service key with the necessary API access permissions for the CPI Transporter.

Back to systems

Step 1: Log in to your SAP BTP Cockpit.

Step 2: Navigate to Service Marketplace.

Step 3: Create a new instance.

Step 4: Configure the new instance.

Step 5: Assign roles (permissions for API access).

Step 6: Create the Service Key.

Step 7: Configure the Service Key.

Step 8: Copy the credentials.