Zilliant microservices expose REST APIs used by Zilliant products. Use these APIs to integrate Zilliant with your systems, automate workflows, and retrieve or update data in a controlled, programmatic way.
Our microservices help you perform various tasks, such as:
Read and update entity data, for example, products, customers, or other logical entities
Run automation workflows and background jobs
Evaluate formulas used in pricing logic or configuration
Embed or retrieve analytics and reports where supported, and more
Each microservice focuses on a specific capability and has its own endpoints, inputs, and behavior.
In the documentation for our microservices, you can find:
What the service does and when to use it
Key concepts and common workflows
Endpoint reference, including paths, parameters, request bodies, and responses
Examples you can copy and adapt
Before you call the APIs
To successfully call Zilliant microservices, collect these environment-specific details first:
Base URL for your environment
X-Forwarded-Host header value for requests originating outside Zilliant’s internal network
Authorization header value to authenticate your requests
Tip
Your Zilliant representative provides environment-specific values.
Base URL
The base URL identifies the API host for a specific customer environment. It provides the scheme://domainName part of each request URL.
Example base URL: https://mycompany.zilliant.com
If you use multiple environments, such as DEV and PROD, each environment has its own base URL. Don’t reuse a PROD base URL in DEV, or the other way around.
Example full request URL (base URL + endpoint path):https://mycompany.zilliant.com/v1/LogicalEntityData/Product?$filter=ProductId eq '114695416'
Note
The
domainNameportion must match the configuredHost_Namevalues in Zilliant SSO Configuration for your environment.
X-Forwarded-Host header
The X-Forwarded-Host header tells Zilliant which OAuth host to use for your environment. Include it in all requests that come outside Zilliant’s internal network.
Example values:
mycompany-dev.zilliant.commycompany.zilliant.com
These values must match the configured OAuth2_Configuration_Id values in Zilliant SSO Configuration for the environment.
Tip
The X-Forwarded-Host value often looks identical to the
domainNamein the base URL, but it is a separate configuration value and might differ depending on your SSO setup.
Example header:X-Forwarded-Host: mycompany.zilliant.com
Authorization header
Zilliant microservices use OAuth 2.0 authentication through Salesforce. To authenticate requests originating outside Zilliant’s internal network, include an Authorization header.
Header format
Set the Authorization header to the keyword OAuth, followed by a space, and then the Base64-encoded JSON token response you received from the token request.
Example:Authorization: OAuth {tokenResponseBase64}
Note
The token value is not only the access_token. Take the entire JSON response from the token request (including the access token and other fields), Base64-encode it, and then use that encoded value after the OAuth keyword.
Use the correct token for each environment
If you use multiple environments, such as DEV and PROD, obtain the token response from the Salesforce org associated with that environment and use the corresponding Base64-encoded JSON value in requests for that environment.
What’s next
Select a microservice to learn the supported operations, endpoints, and workflows
Go to the token request topic when you need to generate or refresh your Salesforce OAuth token response