Skip to main content
EDC Registration using API

Follow these steps to register your EDC on Cofinity-X Portal using API.

Updated over 3 months ago

Step 1: Log into Portal

Create a Technical User and assign the 'Offer Management' role. Once this step is completed, you'll receive a Client ID and Client Secret which are essential for the next steps.

Step 2: Prepare Your POST Request

Use the following endpoint for your POST request:

  • Pre-Prod:

https://portal-backend.beta.cofinity-x.com/api/administration/connectors

  • Prod:

https://portal-backend.services.cofinity-x.com/api/administration/Connectors

Step 3: Set Up Authorization

Go to the Authorization tab in Postman and fill in the following details:

  1. Auth Type: OAuth 2.0

  2. Grant Type: Client Credentials

  3. Access Token URL (PROD): https://centralidp.services.cofinity-x.com/auth/realms/CX-Central/protocol/openid-connect/token

  4. Client ID: Enter the Client ID from the technical user you created.

  5. Client Secret: Enter the Client Secret from the technical user.

  6. Click on ‘Get New Access Token’, and then click 'Use Token' to apply it to your session.

Step 4: Configure the Request Body

Switch to the Body tab, select 'Form-data', and enter the following:

  1. Key: Name - Value: [Choose a name to display for your EDC on the portal]

  2. Key: ConnectorURL - Value: [Your EDC endpoint, e.g., https://testxxx-edc.enablement.preprod.cofinity-x.com]

  3. Key: Location - Value: DE

  4. Key: TechnicalUserID - This is optional unless you want to specify the technical user ID you created.

POSSIBLE ERRORS & SOLUTIONS

  1. 401 Unauthorized: Indicates your token might be invalid or wrong. Ensure you have used the correct role (offer management) for the technical User ID created.

  2. 403 Bad Request: Indicates there’s something wrong in the request you made. More likely to occur if you do not use ‘Form-data’ in the Body tab and you make use of ‘raw’ to input your data. It could also occur if the content type field is not set right in your headers tab.

  3. 403 Forbidden: The request is a legal request but the server is refusing to respond to it. Indicates the client ID and Client Secret do not have the correct role.

  4. 500 Internal Server Error: Cannot determine exactly what is causing the error. Remove the technicalUserID key in your request.

  5. Reach out to customer support for further assistance: support@cofinity-x.com.


Did this answer your question?