API Key
This section explains the process of generating an API Key through both our UpStart Commerce Portal UI and APIs.
Generate an API Key through the UpStart Commerce Portal
To interact and integrate with our Management APIs, the first step is to create an API Key. Follow the steps below to generate an API key through the UpStart Commerce Portal.
Step 1: Log in to the UpStart Commerce Portal
Access the UpStart Commerce Portal and log in using your credentials (Login and Password). If you are not registered, follow this link to create your sandbox account.
Step 2: Access User Details
After successfully logging in, locate your Username in the top right corner. Click on the "Details" button. You will be directed to the "User Management" page.
Step 3: Generate an API Key
Scroll down to the "API Key" section on the page and click on the "GENERATE KEY" button to initiate the key generation process.
Step 4: Fill in API Key Details
Add a unique "Key Name" for your API and set the "Expiration Date", as required. Click on the "GENERATE KEY" button to proceed.
Step 5: Copy API Key
Upon successful generation, the form will display your Key Code. Click on the "Copy Key and Close" button to copy the API Key Code to your clipboard.
IMPORTANT: Copy and save your API key value, as it CANNOT be recovered and will no longer be available once you navigate away from the page.
Step 6: Utilize Your API Key
Once the API Key is successfully generated, you can utilize it to perform various operations and integrations within the UpStart Commerce Platform. To understand the process of making an API call by using an API Key, please refer to this example request.
Generate an API Key through our APIs
Step 1: Create an Account on the UpStart Commerce Portal
To initiate the API Key generation process, you must first have an account on the UpStart Commerce Portal. If you have not registered yet, create an account by visiting this link.
Step 2: Obtain Tenant ID and Session ID
For authorization, you will require two parameters Tenant ID and Session ID.
- Tenant ID: You can create a Tenant ID by visiting this link, or you can request the UpStart Commerce Support Team to create it for you. After successfully creating a Tenant ID, set your specified X-Upstart-tenant in the header authorization field.
- Session ID: You can generate a Session ID by simply copying the Curl below and executing it in a terminal or command prompt.
Request:
curl --location 'https://nochannel-test-1-api.nochannel-test.upstart.team/v1/user/session-login' \
--header 'Content-Type: application/json' \
--header 'Cache-Control: no-cache' \
--header 'X-Upstart-tenant:<your-tenantid>' \
--data
{
"login": "test",
"tenant": "<your-tenantid>",
"password": "<your-password>"
}For more information, go to the Obtain Session ID endpoint example request.
Response:
{
"sessionId": "<your-sessionid>"
}Note: For authorization, you will need two parameters - Tenant ID and Session ID. Ensure to securely store these values for further API interactions.
Step 3: Generate API Key
Copy the Curl command below to generate an API Key. Replace X-Upstart-tenant and X-Upstart-Session-Idwith the specific values obtained in step 2.
Request:
curl --location 'https://nochannel-test-1-api.nochannel-test.upstart.team/v1/user/profile/api-keys' \
--header 'Content-Type: application/json' \
--header 'Cache-Control: no-cache' \
--header 'X-Upstart-tenant: <your-tenantid>' \
--header 'X-Upstart-Session-Id: <Session ID obtained from step 2>' \
--data
{
"name": "test22",
"validTo": "2036-12-17T00:00:00.000Z"
}For more information, go to the Create New API Key endpoint example request.
Step 4: Check the Status Code
Upon making an API Key creation request, it responds with a status code indicating the outcome.
- Success (HTTP 200): The server has successfully processed your request.
- Error Responses: HTTP 401: The server was unable to process the request. Check and ensure that the provided credentials are valid. HTTP 403: The request contains valid credentials, but the user's roles may be insufficient or the credentials may be expired.
Step 5: API Key Generated Successfully
After executing the Curl above, you have successfully generated an API Key. The response includes apiKey and apiKeyId for specific API identification, and validTo to check the expiration date of the API Key. Once generated, you can invoke this API Key to start exploring and testing our Management APIs.
Response:
{
"apiKey": "<your-apiKey>",
"apiKeyId": "<your-apiKeyId>",
"validTo": "2036-01-17T00:00:00Z"
}IMPORTANT: To further interact with our APIs, utilize the apiKey and apiKeyId provided in the response.
By following these steps, you can generate an API Key through our APIs , ensuring secure and authorized access to UpStart Commerce Management APIs.
How to Use an API Key
Once the API Key is generated, you can use it in the header of the API request within the Authorization field. This step is crucial for authenticating and accessing Management APIs.
Example API Request:
To use an API Key, replace your-apiKey in the Authorization header with the actual value of the API Key obtained from the response in step 5.
Make Your First API Call with an API Key
To make your first call by using an API Key, you need to add your API Key and Tenant ID (created above) in the request header by using the Curl below.
Request:
curl --location 'https://nochannel-test-1-api.nochannel-test.upstart.team/v1/user/list' \
--header 'X-Upstart-tenant: <your-tenantid>' \
--header 'Accept: application/json' \
--header 'X-Upstart-API-Key: <your-apiKey>'Replace <your-tenantid>with the Tenant ID of your instance and <your-apiKey> with the corresponding value of your API Key. To execute this API you should have a "Portals Users Management" role.
For more information, go to the Get Users by Tenant ID example request.
Response:
[
{
"id": "id",
"login": " username",
"name": "name",
"userRoles": {
"<tenantId>": {
"roleIds": [
"tenant.admin"
],
"sites": {
"<siteId>": {
"roleIds": []
}
}
}
},
"tenant": "<tenantId>",
"emailAddress": "[email protected]",
"registrationDate": "2023-10-20T15:49:37.738P",
"lock": false,
"system": true
},
{
"id": "id",
"login": "username",
"name": "name",
"userRoles": {
"<tenantId>": {
"roleIds": [
"portal.order.mgmt",
"portal.qa.mgmt",
"portal.customers.mgmt",
"portal.promotions.mgmt",
"portal.inventory.mgmt",
"portal.ratings.mgmt",
"portal.data-capture.mgmt",
"portal.data-feed.mgmt",
"portal.default",
"portal.shipping-carrier.mgmt",
"portal.cart.mgmt",
"portal.wishlist.mgmt",
"portal.clotho.mgmt",
"portal.pim.mgmt",
"portal.users.mgmt",
"portal.catalog.mgmt",
"portal.quotes.mgmt",
"portal.return-policy.mgmt",
"portal.locations.mgmt",
"portal.finance-offers.mgmt",
"portal.analytics.mgmt",
"portal.configurations.mgmt",
"portal.pricing-feed.mgmt"
],
"sites": {
"<siteId>": {
"roleIds": []
}
}
}
},
"tenant": "<tenantId>",
"emailAddress": "[email protected]",
"registrationDate": "2024-12-1234:09:42.300P",
"lock": false,
"system": false
},
{
"id": "id",
"login": "username",
"name": "name",
"userRoles": {
"<tenantId>": {
"roleIds": [
"portal.locations.mgmt",
"portal.default"
],
"sites": {
"<siteId>": {
"roleIds": []
}
}
}
},
"tenant": "<tenantId>",
"emailAddress": "[email protected]",
"registrationDate": "2023-11-21T16:30:38.131Z",
"lock": false,
"system": false
}
]Upon successfully receiving the response for the Get Users by Tenant ID request, you have completed your first UpStart Commerce Management API call, using an API Key.