Session ID

10min
This section explains the process of generating a Session ID through our UpStart Commerce Management APIs.
Generate a Session ID
Step 1: Create an Account on the UpStart Commerce Portal
To initiate the Session ID generation process, you must first have an account on the UpStart 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.
For Tenant ID and Site ID: You can create a valid  and  by visiting this link or you can request the UpStart Commerce Support Team to create it for you. After successfully obtaining them, replace your specific Tenant ID and Site ID in the authorization field.
For Session ID: Make the relevant API call to automatically generate a Session ID by using the Curl below.
Request:
Curl
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>",
	"site": "<your-siteid>",
	"password": "<your-password>"
}'
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>",
	"site": "<your-siteid>",
	"password": "<your-password>"
}'
﻿
For more information, go to the obtain Session ID endpoint example request.
Step 3: Check the Status Code
Upon making a Session ID creation request, it responds with a status code indicating the outcome.
﻿
Response:
JSON
{
    "sessionId": "<your-sessionid>"
}
{
    "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.

After executing the Curl, you have successfully generated a valid Session ID. Now, you can use this Session ID to further explore UpStart Commerce Management APIs.
How to Use Session ID
You can utilize the generated Session ID in the header of your API request using the Authorization field. This step is crucial for authenticating and accessing UpStart Commerce APIs.
Header Key:  ﻿
Header Value:   <your-sessionid>
Example API Request:
Replace <your-sessionid> in the Authorization header with the actual  obtained from response above.
﻿
Make Your First API Call with Session ID
To make your first call by using a Session ID, you need to add your Session ID, Site ID, and Tenant ID (created above) in the request header by using the Curl below.
﻿Request:﻿
Curl
curl --location 'https://nochannel-test-1-api.nochannel-test.upstart.team/v1/user/list' \
--header 'Accept: application/json' \
--header 'X-Upstart-tenant: <your-tenantid>;' \
--header 'X-Upstart-site: <your-siteid>;' \
--header 'X-Upstart-Session-Id: <SessionId obtained from step 2>;'
curl --location 'https://nochannel-test-1-api.nochannel-test.upstart.team/v1/user/list' \
--header 'Accept: application/json' \
--header 'X-Upstart-tenant: <your-tenantid>;' \
--header 'X-Upstart-site: <your-siteid>;' \
--header 'X-Upstart-Session-Id: <SessionId obtained from step 2>;'
﻿
For more information, go to the Get Users by Tenant ID example request.
Response:
JSON
[
    {
        "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-21T15: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
    }
]
[
    {
        "id": "id",
        "login": " username",
        "name": "name",
        "userRoles": {
            "<tenantId>": {
                "roleIds": [
                    "tenant.admin"
                ],
                "sites": {
                    "<siteId>": {
                        "roleIds": []
                    }
                }
            }
        },
        "tenant": "<tenantId>",
        "emailAddress": "emailaddress@example.com",
        "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": "emailaddress@example.com",
        "registrationDate": "2024-12-21T15: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": "emailaddress@example.com",
        "registrationDate": "2023-11-21T16:30:38.131Z",
        "lock": false,
        "system": false
    }
]
﻿
Upon receiving the successful response for the Get User by Tenant ID request, you have completed your first UpStart Commerce Management API call, using the Session ID.
Did this page help you?
API Key
Consumer APIs