<p>about your learning experience to help us improve.</p>

You've completed

cleanFiles/bookmap_Configuring_SAP_CIAM_for_B2B_en-US_learning-sap-com_lsc-prod.zip (MMCP-DROPZONE) - 2024-12-05T11:57:17.000Z

Additional Reading

<div id="content"><p tabindex="0">Now that we've covered B2B-related material, you may find the following video interesting: it covers how to use APIs to integrate CDC to an external system. Enjoy!</p><div class="kalturaVideoLessonWrapper"><div aria-label="" class="kalturaVideoLessonContainer" data-testid="video" id="1_7yh4981e"></div></div></div>

Integrating an External System to SAP Customer Data Cloud Using APIs

From Onboarding to Governance: Mastering SAP Customer Data Cloud for B2B

U6L3 Accessing SAP Content Data Cloud Using its APIs.mp4

In this video, we’ll be covering how to access CDC using its API. We’ll use two scenarios to do this: First, register a new customer via the API. Second, use a CDC Webhook to detect when a new customer has registered, sync that customer to a downstream system, then update the CDC with the ID from that downstream system using the CDC REST API. Let’s talk about the CDC API. The core of the SAP CDC service is a REST interface. There are several SDKs that wrap around the API, the most useful being the WebSDK, which looks after all the API calls to CDC from the client side. The CDC APIs are well documented in the SAP CDC Help Portal. Most CDC APIs require authorization parameters for security purposes. The recommended best practice is to generate an authorization bearer token. The relevant section in the help docs show you how to do this. Alternatively, you can use an application key and secret, which can be generated within the Admin Console. This is what we’ll use in this demo. Also important to note that all post data must be URL encoded, whether in the query or the body. The API will return error codes to indicate when information is incorrect or missing. For a comprehensive list of SAP CDC error codes, refer to the Help Portal shown here. Now let’s create an application in the CDC Admin Console to use for our API calls. To do this, we’ll switch to the Admin Console, click on ‘Administration’ at the bottom, and then ‘Applications’. To create a new application (or System), click ‘Create New’. Enter a Name and select a Group, which will define the access privileges. I’ll use a group I created earlier, ‘API Access’, and click ‘Create’. In the popup that appears, you can see the user key and secret that have been generated. These can be used to authorize the API. I’ll now copy these to a text editor, along with the site API key from the sites table. Next, we’ll create the webhook for the second part of the demo. Webhooks are asynchronous events that CDC can send to an external endpoint when something happens. I will click on ‘Create Webhook’ and give it a name. For the ‘Notification URL’, I’ll use a temporary endpoint from a development tool at ‘webhook.site’ that can receive the webhook. The event we want this webhook to fire for is ‘Account Registered’. Click ‘Create’. Now whenever a new account is registered, the webhook event will be sent to the endpoint I configured. I’ll now switch over to my API Tool to start the first scenario, registering a new customer via the API. We need to link a few APIs in sequence to register a customer using the API from the client side. First, we call accounts.initRegistration to get a regToken. Then we use that regToken, along with all the User’s registration information, to call accounts.register. We then need to set the API key. We don’t need the user key or secret to register a member. We’ll set the data center to EU, and the endpoint we want is accounts.initRegistration. This API doesn’t require any additional parameters for our demo, other than the common parameters like apiKey, userKey and secret. I’ll call this, and you can now see the regToken in the response. Next we’ll switch to the accounts.register API. Here we need several parameters. In addition to the regToken from the previous step, we need to add the email, the password, and the profile JSON. The JSON content includes  the first and last name, Jane Doe. We can include other information here, but we’ll limit ourselves to basic data for this demo. Finally, we include the ‘finalizeRegistration’ parameter, which we’ll set to true. Had we omitted this, we’d have to call the ‘finalizeRegistration’ API after this one to complete the registration process. I’ll now trigger the call. You can see it has gone through successfully and the API returned the account profile for the new user. Next, we can check the Admin Console to see this new user. Switching back to the CDC Admin Console, Switching back to the CDC Admin Console, I’ll click on ‘Identity Access’ / ‘Profiles’. And here is the new customer I just registered  via the API,  ‘Jane Doe’. If I click on her record, all her details are displayed. For the second part of this demo, we want to sync Jane’s profile to a downstream system, then update her profile in CDC with the BPID from that downstream system. This would all be triggered by the ‘Account Registered’ webhook we set up previously. Now let’s switch tools. This is the dev tool I’m using to catch the webhook events that are triggered from CDC. Here, we can see the Account Registered webhook event that was sent from CDC when I registered Jane Doe. The key information in the payload is: the webhook type, the API key, the UID, which was generated by CDC when the user account was created, and the information provided by the user during registration, for example their first and last names. Using the information provided in this webhook event, I’m able to have the creation of this customer trigger an API in another downstream system, such as a CRM. I won’t cover the API of the downstream system in this demo, as its not related to CDC, but the intention is to have the downstream system generate another ID, say a BPID for the user that we then want to update back into CDC. To perform this update of the customer’s profile in CDC,  we want to use the CDC API accounts.setAccountInfo. This API would be called from the server side, so we’ll need to use the Application User credentials we previously generated to call it. For any account updates in CDC, we nearly always use setAccountInfo, which can update about 95% of the Account fields. For some special fields, like phoneNumber or UID, we’d need to use different APIs. The related API to read an account is accounts.getAccountInfo. Let’s now update the BPID into the customer’s CDC profile. First, we set the endpoint to accounts.setAccountInfo. The data center can stay as ‘EU’, and here we need our Application User Key and Secret Key which I’ve previously copied from the Admin Console. For the payload, we add a data object that updates the custom fields on the CDC Accounts schema.  I’ve previously created a string field called ‘BPID’ to store the BPID from the downstream system into. Let’s set this to ‘BP001’. We need to set the UID parameter to update Jane’s profile data. That’s it for the API config. Let’s execute it. That went through successfully and I can see the account object in the response. Let’s now check it in the Admin Console. I’ll go back to the profile list and click search to reload the profiles. And here is the new customer ‘Jane Doe’ again. If I click on her record, you can see here that she now has a BPID field set to ‘BP001’. That concludes this video on how to use the CDC API.  Thanks for watching.