To start using Digital Experience Cloud data collection and personalization API, you first need to have:
NOTE: If you do not have a DEC account, contact firstname.lastname@example.org for information about getting a trial version of DEC, as well as purchasing DEC licenses.
Next, you can proceed with getting your authorization token and obtaining the data center API key. You will need both to use the majority of DEC endpoints.
By calling the following endpoint, you agree to the latest DEC terms and conditions.
NOTE: You can obtain the full text of the terms and conditions from the Cloud services agreement.
Body is not required.
To use the secured DEC endpoints, you need to obtain an authorization token. The recommended way of obtaining an authorization token is by using an access key. The token is obtained by calling the endpoint resource described in details in this section. Similar to the authorization token obtained with your Telerik account, the authorization token with access key is valid for 60 minutes. For more information, see Access keys.
No parameters are required for this endpoint.
"AccessKey": " eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhcGlzZXJ2ZXIiLCJzdWIiOiIyYzM0MJMwOS0yZDA1LTYxMTMtNTM5MS1mODFlMzBlMDFlNmQiLCJ0eXBlIjoxLCJpYXQiOjE1NjMxODA3MjcsImF1ZCI6InNmLWNvbm5lY3RvciJ9.orCufOBCjgFvC8vYzut6Cjvm9R1aGwk_ZUrB0YZYDxBmfaT6Oc5QQHN18Msyfv9NBAMgu-Z8Xx-axY7bC5FL82X6udLngPiq6juPEgaq6bwt0NB3VkngGFzAy4vNJL20g-Fs28SaUuKM8ng7O1Omf6mubYDaTt_1jLZk8IJqwID7jcK_l9PI0Z5P6ENLVqoypIf3munL8Npw4dZ8HrrRgbrGtndRja9ZkUR-n4lNjbEjcXxGGD2T2t9h-4_KuRDCt81jYJ9yl5nlmBq8jkqV7dMi4gpgUwt2VPhivejj6gcUBCyakzeTJuk93bivGXSqXS8SegYdmVlonKkEIXPeUD"
In the example above, the value that you need to provide to the Authorization header of the secured DEC API server endpoints is bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhcGlzZXJ2ZXIiLCJzdWIiOiIyYzM0MDMwOS0yZDA1LTYxMTMtNTM5MS1mODFlMzBlMDFlNmQiLCJ0eXBlIjoyLCJpYXQiOjE1NjQwNDUwNTgsImV4cCI6MTU2NDA0ODY1OCwiYXVkIjoic2YtY29ubmVjdG9yIn0.binP7vmJUBYPZUKJ9nA48-sD1fEmBY3o9MI8lq_Ub0kXz16Hhx9OJpO4E0rm0MK1A_LkVA7TOmf0E_r0uI-xGrJe11_yvgY9B2l06KD1whQAkLCwDsvb5HJE_eVmIZp2QgtopevhAR_l92sruhLs-0WwzVGVq5ETZ8hWxK202B_MYOTPxt2-0pg9j819qWZt3xYHpwKxCD-2EXoNkQ5flaYBBU9PUcZiGVNFdcJR2iZ2o9WpvN5M5K4kXPb7kLY5DG_pQpYZ9SksPdNQnqGJ9f3PE2tXZBcZf_HT2syJQNTniAljLPuvPDuz49quVR_pCUkASXVgD_XTC15XOyIybg.
Another option of obtaining an authorization token is by using your Telerik account. You do this by using the resource described below. By concatenating the access_token and token_type properties of the response, you get the string you need to use in the Authorization header in all secured DEC endpoints. For example, if the access_token returned is “123456” and the token_type is “bearer”, your DEC authorization is bearer 123456.
NOTE: The token returned from the /admin/v1/users/issue-access-token endpoint is valid for 60 minutes.
In the example above, the value that you need to provide to the Authorization header of the secured DEC API server endpoints is bearer ebJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYmYiOjE1MTc5MzkzMjMsImV4cCI6MTUxNzk0MjkyMywianRpIjoiNDYxMzhmZjQ3YTg1NDJlZWI3N.
A third way of authorizing is by creating an authorized application in DEC Web app. Navigate to the Administration panel of the data center and open the Authorized applications tab page. Once you generate a token, to place it in the Authorization header, concatenate it with appAuth. For example, if your token is “78910”, you need to provide appAuth 78910 to authenticate.
NOTE: Authorized applications can only access the personalization endpoints of DEC. For more information, see Personalization API endpoints.
To work with the majority of DEC endpoints, you are required to provide the API key of the data center. The reason is that most of the data, related to DEC, is data center-bound. The following sections explain the two ways of obtaining the data center API key.
Use the following API resource to obtain the API keys of the data centers you need access to.
Data is returned in JSON format, for example:
You can filter the data centers by some of their properties:
For more information, see Data center API data type.
You can work with two DEC API versions, which also reflect the Sitefinity CMS you are working with:
RECOMMENDATION: We recommend working with the newer version of the DEC API.
Back To Top
To submit feedback, please update your cookie settings and allow the usage of Functional cookies.
Your feedback about this content is important
Copyright © 2019 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.