Allows you to fetch the underlying API keys and tokens that are used to make authenticated requests for each platform. Depending on the type
of authentication used in the underlying platform, different fields may be returned. You should view the platform-specific API pages to properly format your request.
OAuth
If the credential type
is oauth
, an access_token
property will be included along with any other required pieces of information to make a direct API call, which can be used to make authenticated requests to the platform directly. NOTE: Refresh Tokens are not returned, to prevent loss of access.
{
"credential": {
"type": "oauth",
"access_token": "ACCESS_TOKEN"
"store_url": "test.myshopify.com"
},
"connection": {
"id": "0f801665-5caa-4717-8ff0-9bfdb351ce11",
"platform": "SHOPIFY"
}
}
OAuth 1.0a
If the credential type
is oauth1.0a
, the 4 fields necessary to generate an authenticated requests are returned.
{
"credential": {
"type": "oauth1.0a",
"oauth_consumer_key": "CONSUMER_KEY",
"oauth_consumer_secret": "CONSUMER_SECRET",
"oauth_token": "OAUTH_TOKEN",
"oauth_token_secret": "OAUTH_TOKEN_SECRET"
},
"connection": {
"id": "0f801665-5caa-4717-8ff0-9bfdb351ce02",
"platform": "ETSY"
}
}
Basic
If the credential type
is basic
, the platform API uses Basic access authentication.
{
"credential": {
"type": "basic",
"username": "USERNAME",
"password": "PASSWORD",
},
"connection": {
"id": "0f801665-5caa-4717-8ff0-9bfdb351ce02",
"platform": "SHOPIFY"
}
}