SAP Cloud Platform Open Connectors

Authenticated Connector Instances

An authenticated connector instance represents a connection between a single user and an API provider where they have an account. When you authenticate with an API Provider you create a connector instance in SAP Cloud Platform Open Connectors. Use the authenticated connector instance to apply logic to the connector instance with formulas, map your connector instance to a common resources, and test your instance in the API docs.

When you authenticate through SAP Cloud Platform Open Connectors, you authorize SAP Cloud Platform Open Connectors to access your data at the API provider. If you need to authorize your own application to access an API provider use the /instances API.

Authenticate A connector Instance

Each API provider is different. You can authenticate a connector instance through SAP Cloud Platform Open Connectors, or via the /instances API. Because of the differences between each connector, SAP Cloud Platform Open Connectors provides detailed documentation for each connector. The connector documentation includes steps to prepare for authentication, how to authenticate through SAP Cloud Platform Open Connectors or the instances API, and additional information about bulk, querying, and events.

View Connector Instance Information

Each authenticated connector instance is identifiable by it's unique connector instance ID and connector instance token. Use the connector instance ID to refer to the instance in formulas and scripts. SAP Cloud Platform Open Connectors uses the connector instance token to authenticate with an API provider. You must pass the connector instance token in the header of any API requests to the connector.

To locate your connector instance ID and connector instance token:

  1. Click the instances banner on a connector card.
  2. Note the connector instance ID at the top of the card.
  3. Hover over the connector instance card, and then click View Token.

Test A connector Instance

After you authenticate a connector instance, you can test it with the API docs. So long as you have an authenticated connector instance, you can test any of the requests in the API docs. For more information about the connector API docs, see the Overview.

To test your connector instance:

  1. Click the instances banner on A connector card.
  2. Hover over the connector instance card, and then click API Docs.
  3. Expand the endpoint that you want to make a request to.
  4. Click Try it Out.
  5. Supply any additional or required information.
  6. Click Execute.

Update A connector Instance

You can edit your connector instance or re-authenticate with an API provider. If you just need to change basic information about the connector, you can update without re-authenticating. However, if you need to add events or update some configuration value, you must re-authenticate.

Note: If you authenticated the connector instance through the API do not try to update it in SAP Cloud Platform Open Connectors. Instead, use the /instances API.

To update an authenticated connector instance:

  1. Click the instances banner on a connector card.
  2. Hover over the connector instance card, and then click Edit.
  3. Make your changes, and then click Update.

To re-authenticate an authenticated connector instance:

  1. Click the instances banner on A connector card.
  2. Hover over the connector instance card, and then click Edit.
  3. Make your changes, and then click Re-Authenticate.

Delete

You can delete a connector instance, which permanently deletes the instance and it's connector instance token from SAP Cloud Platform Open Connectors.

To delete a connector instance:

  1. Click the instances banner on a connector card.
  2. Hover over the connector instance card, and then click Delete.
  3. Confirm the deletion.