[color=rgba(0, 0, 0, 0.8)]根据API提供商的身份验证要求(OAuth 2.0,基本,OAuth 1.0或自定义)以及他们需要的任何特定信息,如何使用我们的API对连接器实例进行身份验证与连接器的区别很大。但是,您发送的有效负载始终包括基本信息,包括name元素实例,configuration将所需信息传递给提供程序的数组,tags帮助您对实例进行分类,以及检索有关对象的详细信息的可选请求retrieveObjectsAfterInstantiation(请参阅更多相关信息)下面)。
[color=rgba(0, 0, 0, 0.8)]您可以使用以下任一端点对连接器实例进行身份验证:
POST /实例POST / elements / {id} / instances(不包括"key": "Element Key"在请求正文中)。[color=rgba(0, 0, 0, 0.8)]以下是使用OAuth 2.0身份验证对连接器实例进行身份验证的示例有效内容:
{
"element":{
"key":"<Element Key>"
},
"providerData":{
"code":"<Authorization Grant Code>"
},
"configuration":{
"oauth.api.key": "<OAuth app API or Client Key>",
"oauth.api.secret":"<OAuth app API or Client Secret>",
"oauth.callback.url":"<Callback URL>"
},
"tags":[
"Tag Name 1",
"Tag Name 2"
],
"name":"Instance Name",
"retrieveObjectsAfterInstantiation": true
}
[color=rgba(0, 0, 0, 0.8)]以下是使用基本身份验证验证连接器实例的示例有效内容
{
"element": {
"key": "<Element Key>"
},
"configuration": {
"username": "<User Name>",
"password": "<Password>"
},
"tags": [
"Tag Name 1",
"Tag Name 2"
],
"name": "<Instance Name>",
"retrieveObjectsAfterInstantiation": true
}
在响应中包含对象
[color=rgba(0, 0, 0, 0.8)]您可以返回连接器中所有数据对象及其源(供应商,公共资源或规范化SAP Cloud Platform Open Connectors对象)的列表。在请求正文中包含可选"retrieveObjectsAfterInstantiation": true值。响应包括一个objects像这个例子的数组:
"objects": [
{
"name": "incidents",
"vendorName": "Case",
"type": "ceCanonical"
},
{
"name": "Task",
"vendorName": "Task",
"type": "vendor"
},
{
"name": "myAccounts",
"vendorName": "Account",
"type": "vdr"
}
]
[color=rgba(0, 0, 0, 0.8)]对象列表包括:
name连接器对象的名称。这是您可以在API文档和端点中找到的名称。例如,对示例中对象的请求看起来像GET https://api.openconnectors.us2.e ... ts/api-v2/incidents(/Task或/myAccounts)。vendorName API提供程序系统中指定的对象的名称。type 指定定义对象的位置:vdr表示该对象是用户定义的公共资源,该资源映射到vendorName属性中标识的API提供程序资源。有关更多信息,请参阅公共资源简介。ceCanonical表示与vendorName属性中标识的原始API提供程序对象关联的规范化SAP Cloud Platform Open Connectors对象。vendor表示该对象可通过GET /{objectName}端点使用。请求绕过任何SAP Cloud Platform Open Connectors映射并直接调用供应商端点,同时仍由SAP Cloud Platform Open Connectors代理。在这种情况下,name和vendorName属性是相同的。