Skip to Content
Technical Articles

Connector Builder Guide – Resource Types

Connector Builder Guide – Resource Types

Open Connectors consists of over 170 connectors to 3rd Party Applications natively embedded in the SAP ecosystem. If the Connector you need does not exist in the catalog, you can build it quickly with Connector Builder. This instruction guide will walk you through using this tool, with concrete examples throughout. The beginning, Part 1, can be found here.

 

The resource types signify when the resource will execute and if they will show up in the swagger API docs (the API Docs tab). Here we will explain what each type does.

API

Runs when specifically called after the Connector Instance is created. Exposed in Swagger. This is the most commonly used resource type.

API NO DOCUMENTATION

Runs when specifically called after the Connector Instance is created. Not exposed in Swagger. This is used when you want a resource to be callable, but hidden. This comes in handy when chaining resources together and you want the second resource in the chain to be hidden.

ON DELETE

Runs when the Connector Instance is deleted. Not exposed in Swagger. This is useful when you want to take an action upon the deletion of the Connector Instance, like perhaps revoking the access token.

ON PROVISION

Runs when the Connector Instance is created. Not exposed in Swagger. This is useful when a token needs to be created as part of custom authentication when the Connector Instance is created (see Client Credentials auth as an example).

ON REFRESH

Runs when the Connector Instance is refreshed. Not exposed in Swagger. This is useful when another action has to take place after an Oauth 2 token has been refreshed, like using that token to get a new session token.

PROVISION AUTH VALIDATION

Runs when the Connector Instance is created and also runs at the interval determined by the value of configuration variable “expires_in” . Not exposed in Swagger. This is useful when a token needs to be created as part of custom authentication when the Connector Instance is created and it needs to be refreshed after it expires (see Client Credentials auth as an example).

ON PROVISION WEBHOOK

Runs when the Connector Instance is created if Events have been enabled. Not exposed in Swagger. This is useful when webhooks can be programmatically created in the vendor application. They need to be created once when the Connector Instance is created.

ON DELETE WEBHOOK

Runs when the Connector Instance is deleted. Not exposed in Swagger. This is useful when you have webhooks that are created in the vendor application that point to the Connector Instance webhook URL. Once the Instance is deleted, that URL will not exist. This way, you can garbage collect those webhooks.

OAUTH ON AUTHORIZE URL

Runs as the authorize endpoint in an Oauth flow. Not exposed in Swagger. The Oauth 2 authentication type will execute the authorize URL endpoint. Sometimes, however, this call may need something non standard, like perhaps an extra form parameter. If this is the case, it is best to build this resource manually. The other aspects of the Oauth flow will remain unchanged and execute accordingly.

OAUTH ON TOKEN EXCHANGE

Runs as the token endpoint in an Oauth flow. Not exposed in Swagger. The Oauth 2 authentication type will execute the authorize URL endpoint and then the token endpoint. Sometimes, however, this call may need something non standard, like perhaps an extra form parameter. If this is the case, it is best to build this resource manually. The other aspects of the Oauth flow will remain unchanged and execute accordingly.

OAUTH ON TOKEN REFRESH

Runs as the token refresh endpoint in an Oauth flow. Not exposed in Swagger. The Oauth 2 authentication type will execute the token refresh URL. Sometimes, however, this call may need something non standard, like perhaps an extra form parameter. If this is the case, it is best to build this resource manually. The other aspects of the Oauth flow will remain unchanged and execute accordingly.

Be the first to leave a comment
You must be Logged on to comment or reply to a post.