Root API
Less than to read
In our solution architecture, each region has its root API, for example https://api.myregion-sagex3.com/v1. In the production mode, the regions are, for example, eu-prod, us-prod… A simple curl command or navigation with a browser shows all available endpoints for making API calls:
HTTPS 1.1 GET https://api.myregion-sagex3.com/v1
{
"customerAccess": {
"authorise": "https://api.myregion-sagex3.com/v1/token/authorise",
"token": "https://api.myregion-sagex3.com/v1/token"
},
"customerUsage": {
"folder": "https://api.myregion-sagex3.com/v1/folders",
"graphQL": "https://api.myregion-sagex3.com/v1/service/{endPoint}/api",
"dataIngestion": "https://api.myregion-sagex3.com/v1/dataingestion/{folderName}",
"dataDelivery": "https://api.myregion-sagex3.com/v1/datadelivery/{folderName}"
},
"apiDoc": "https://api.myregion-sagex3.com/v1/swagger",
"businessDomains": [
"ALL"
]
}
This list contains all available endpoints of the X3. In this guide, these endpoints are divided into different topics to make it easier for you to navigate through:
- Authorization and Token Management Endpoints: This reference section explains how to work with our secured endpoints.
- Folders Endpoint: This reference section shows how to get all available navigable links of each folder inside X3 storage. Want to know what is a folder? click on this link.
- Data Delivery Endpoint: This reference section shows all available operations of Data Delivery Endpoint.
- Data Ingestion Endpoint: This reference section shows all available operations of Data Ingestion Endpoint.