The objects available within our connector are accessible from the "cdata.sagex3cloud" module. To use the module's objects directly:

1. Import the module as follows:
   

   import cdata.sagex3cloud as mod

2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
   

   mod.connect("URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;")

Authenticating to Sage X3 Cloud

Sage X3 Cloud uses OAuth 2.0 Client Credentials flow for authentication. An X-API-Key is also required for API access. Set AuthScheme to OAuth.

Setting Up Authentication

To authenticate, specify these connection properties:

• OAuthAccessTokenUrl: The OAuth token endpoint (for example, https://your-auth-domain/oauth/token).
• OAuthClientId: Your OAuth application client ID.
• OAuthClientSecret: Your OAuth application client secret.
• Audience: The API audience value for the token request.
• XAPIKey: The X-API-Key provided by your Sage X3 Cloud administrator.
• URL: The base URL of your Sage X3 Cloud instance.
• Folder: The Sage X3 folder name (for example, SEED). This folder is used as the default schema.
• Folders: An optional comma-separated list of Sage X3 folders (for example, SEED,PERF). Each folder is exposed as a separate schema, allowing you to query tables across multiple folders using the Schema.Table syntax. When this property is not set, only the folder specified in Folder is available.

The connector automatically obtains an access token using the Client Credentials flow and includes it with the X-API-Key in all API requests. Set InitiateOAuth to GETANDREFRESH (the default) to have the connector handle token acquisition and refresh automatically.