Pushing Id to Keyring

Gravito can be used to manage various keys you have for your consumers. Once push the keys to your consumers profile, it can be fetched based on its type.

get
Fetching keys from the keyring

https://handshake.gravito.net/api/ap/keyring/guid/{guid}/key/{keyid}
This endpoint can be used to fetch the keys from the key-ring of the profile. The fetching of the key ring is governed by the hierarchy of the consent types under which the keys have been pushed to. You can know more about the types of consents supported by Gravito here: Concepts. The fetching capability is mainly provided to fetch for similar key which is available in the profile. For eg: If you have already pushed Google's Analytics Id as well as Adobe's Analytics Id under the consent type of Analytics, at any time you can fetch both with either one of it together with the GravitoId of the profile
Request
Response
Request
Path Parameters
keyid
required
string
They key which is being used to fetch the similar or
guid
required
string
The gravitoUid of the user in context.
Query Parameters
domainKey
optional
string
The access token you have received from the Gravito administration page
domain
required
string
Your domain name under which you are fetching the key from.
Response
200: OK
On successfully identifying the key the request will return all related keys of the same consent type of the key in the query. Also it will give back all the keys which are hierarchically under the key passed. Here in the example a Reidentifcation id from the highest consent type was passed which return Analytics Targeting and the Re-identification id itself.
[
{
"KeyId": "FacebookMarketingId",
"Keyname": "Facebook marketing Id",
"Consent": "Targeting"
},
{
"KeyId": "AdobeAnalyticsId",
"Keyname": "Adobe Analytics Id",
"Consent": "Analytics"
},
{
"KeyId": "somegoogleIdentifier",
"Keyname": "Google Analytics Id",
"Consent": "Analytics"
},
{
"KeyId": "YOurCRMID",
"Keyname": "CRM Identification",
"Consent": "ReIdentification"
}
] // example request only for reference
404: Not Found
When no keys have been mapped for the user
{
"ErrorCode": 404,
"GravitoErrorCode": "GRA7003",
"Description": "Not Found",
"DocumentationLink": "docs.gravito.net"
}

post
Push Key into the profiles key-ring

https://handshake.gravito.net/api/ap/keyring
This endpoint is used to push the ids to the users keyring. One when pushing the keys please make sure you mention the ConsentType as one of the data consents which Gravito accepts. You can find more about that here : Concepts
Request
Response
Request
Body Parameters
Json body
required
object
The sample Json as mentioned below.
Response
200: OK
On successful push into the profile the gravitoUid is returned
{
"GravitoUid": "c6a86749-257e-4f88-a141-51d6fa9f156a-p71"
}
{
"GravitoUId":<string>,
"Domain":<string>,
"KeyId":<string>,
"KeyName":<string>,
"ConsentType":<string>
}