Create Store Login URL | BigCommerce Developer Center

POST /stores/{store_id}/login-url allows you to create a one-time login URL to redirect a merchant to their store control panel. You need to use a form to send a POST request and redirect the merchant’s browser to the action URL because most browsers only support GET requests in the address bar.

Sample

1 loginForm = document.createElement("form");
2 loginForm.setAttribute("method", "post");
3 loginForm.setAttribute("action", "store login URL returned from endpoint");
4 document.getElementsByTagName("body")[0].appendChild(loginForm);
5 loginForm.submit();

One-time login URLs support deep linking.

You can have multiple active sessions for a singular user as long each is session is created through unique login URLs. This is important you are using a single login such as customerservice@partner.com to access merchants’ stores.

`POST` `/stores/{store_id}/login-url` allows you to create a one-time login URL to redirect a merchant to their store control panel. You need to use a form to send a `POST` request and redirect the merchant’s browser to the action URL because most browsers only support `GET` requests in the address bar. ```javascript title=Sample Form Request loginForm = document.createElement("form"); loginForm.setAttribute("method", "post"); loginForm.setAttribute("action", "store login URL returned from endpoint"); document.getElementsByTagName("body")[0].appendChild(loginForm); loginForm.submit(); ``` One-time login URLs support deep linking. You can have multiple active sessions for a singular user as long each is session is created through unique login URLs. This is important you are using a single login such as customerservice@partner.com to access merchants' stores.

Authentication

X-Auth-Tokenstring

An OAuth token generated from the franchise API account.

To authenticate, generate an OAuth Token (if you donʼt have one or itʼs expired):

1 POST https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/oauth/token
2 Accept: application/json
3 X-Auth-Client: {client_id}
4 X-Auth-Secret: {client_secret}
5 
6 {
7   "duration": 900
8 }

Response:

1 {
2   "access_token": "dlkJcn34...Lkd012",
3   "expires_at": "2018-04-24T16:15:26.509045122Z”
4 }

After you generate an OAuth token, use the client_id and oauth_token to authenticate all other API requests:

1 GET https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/accounts/123
2 Accept: application/json
3 X-Auth-Client: {client_id}
4 X-Auth-Token: {oauth_token}

Response:

1 {
2   "data": {
3     "id": "12345678910",
4     "name": "Test Company",
5     ...
6   },
7   "meta": {}
8 }

An OAuth token generated from the franchise API account. To authenticate, generate an **OAuth Token** (if you donʼt have one or itʼs expired): ```http POST https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/oauth/token Accept: application/json X-Auth-Client: {client_id} X-Auth-Secret: {client_secret} { "duration": 900 } ``` Response: ```json { "access_token": "dlkJcn34...Lkd012", "expires_at": "2018-04-24T16:15:26.509045122Z” } ``` After you generate an **OAuth token**, use the `client_id` and `oauth_token` to authenticate all other API requests: ```http GET https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/accounts/123 Accept: application/json X-Auth-Client: {client_id} X-Auth-Token: {oauth_token} ``` Response: ```json { "data": { "id": "12345678910", "name": "Test Company", ... }, "meta": {} } ```

Request

An OAuth token generated from the franchise API account.

To authenticate, generate an OAuth Token (if you donʼt have one or itʼs expired):

1 POST https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/oauth/token
2 Accept: application/json
3 X-Auth-Client: {client_id}
4 X-Auth-Secret: {client_secret}
5 
6 {
7   "duration": 900
8 }

Response:

1 {
2   "access_token": "dlkJcn34...Lkd012",
3   "expires_at": "2018-04-24T16:15:26.509045122Z”
4 }

After you generate an OAuth token, use the client_id and oauth_token to authenticate all other API requests:

1 GET https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/accounts/123
2 Accept: application/json
3 X-Auth-Client: {client_id}
4 X-Auth-Token: {oauth_token}

Response:

1 {
2   "data": {
3     "id": "12345678910",
4     "name": "Test Company",
5     ...
6   },
7   "meta": {}
8 }

1	curl -X POST https://api.bigcommerce.com/franchises/franchise_uuid/v1/stores/store_id/login-url \
2	-H "X-Auth-Client: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"user_email": "hello@example.com"
6	}'

1	loginForm = document.createElement("form");
2	loginForm.setAttribute("method", "post");
3	loginForm.setAttribute("action", "store login URL returned from endpoint");
4	document.getElementsByTagName("body")[0].appendChild(loginForm);
5	loginForm.submit();

1	POST https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/oauth/token
2	Accept: application/json
3	X-Auth-Client: {client_id}
4	X-Auth-Secret: {client_secret}
5
6	{
7	"duration": 900
8	}

1	{
2	"access_token": "dlkJcn34...Lkd012",
3	"expires_at": "2018-04-24T16:15:26.509045122Z”
4	}

1	GET https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/accounts/123
2	Accept: application/json
3	X-Auth-Client: {client_id}
4	X-Auth-Token: {oauth_token}

1	{
2	"data": {
3	"id": "12345678910",
4	"name": "Test Company",
5	...
6	},
7	"meta": {}
8	}

1	{
2	"data": {
3	"login-url": "https://login.bigcommerce.com/sso/express-logins/asdf1234/agdsa2214321rnfjdwjkflewrb318orewfij3wfcdn2/wpl8zqW95J0UafEaOySMvKVNA83%0AqVK5z1gUkXlEBSyFkOS7D7msDR8nYG0IECEtBDUhlGsKIVZWDZi0GVD6pg5+%0AbEEFvaMrhxbEgtaUUgoX1w==%0A"
4	},
5	"meta": {}
6	}

Authentication

Path parameters

Request

Response

Errors