Session ID

10 min

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 https //sandbox nochannel io/setup/create 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 {{tenant header field name}} and {{site header field name}} by visiting https //sandbox nochannel io/setup/create 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 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 https //apidocs upstartcommerce com/docs/user svc/b7470480b133f session login user 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 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 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 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 {{sessionid header field name}} header value \<your sessionid> example api request replace \<your sessionid> in the authorization header with the actual {{sessionid header field name}} 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 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 https //apidocs upstartcommerce com/docs/user svc/303e2f9c0d2f6 get users by tenant example request response \[ { "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