Skip to main content

Get by Key [GET]

Overview

Supply a valid token and content key

Parameters

ParameterTypeDescription
Tokenstring (query)Token supplied during on-boarding or can be generated from within RCM Admin.
Keystring (query)Unique key for the site content, you can see all valid using the getkeys API call.

Example Value

200 response
{
"responseTime": "string",
"token": "string",
"errors": [
"string"
],
"content": {
"key": "string",
"url": "string",
"content": "string",
"contentValues": "string",
"metaTitle": "string",
"metaDescription": "string"
},
"trackingInformation": {
"pageId": 0,
"ruleId": 0
}
}

Response

Description: keys returned

200 response
{
"success": true,
"errors": [
"string"
],
"importTaskId": 0
}

Get by URL [GET]

Overview

Supply a valid token and relative page url

Parameters

ParameterTypeDescription
Tokenstring (query)Token supplied during on-boarding or can be generated from within RCMAdmin.
SiteNamestring (query)This is the site name used to describe your regional version of the website, as supplied in the feeds to Vybe.
Languagestring (query)3 digit ISO code for the site language. i.e. ENG.
Urlstring (query)(optional) Website relative url for this content for example /aboutus.

Example Value

200 response
{
"responseTime": "string",
"token": "string",
"errors": [
"string"
],
"content": {
"key": "string",
"url": "string",
"content": "string",
"contentValues": "string",
"metaTitle": "string",
"metaDescription": "string"
},
"trackingInformation": {
"pageId": 0,
"ruleId": 0
}
}

Response

Description: keys returned

200 response
{
"success": true,
"errors": [
"string"
],
"importTaskId": 0
}

Get Keys [GET]

Overview

Supply a valid token and site name to retrieve all valid content keys.

Parameters

ParameterTypeDescription
Tokenstring (query)Token supplied during on-boarding or can be generated from within RCMAdmin.
SiteNamestring (query)This is the site name used to describe your regional version of the website, as supplied in the feeds to RCM.
Languagestring (query)3 digit ISO code for the site language. i.e. ENG.

Example Value

200 response
{
"keys": [
{
"dateModified": "string",
"key": "string",
"url": "string",
"siteName": "string",
"language": "string"
}
],
"responseTime": "string",
"token": "string",
"errors": [
"string"
]
}

Response

Description: keys returned

200 response
{
"success": true,
"errors": [
"string"
],
"importTaskId": 0
}