Auth

Storefront Auth API endpoints

Endpoints

POST/auth/login
POST/auth/otp/login
POST/auth/otp
POST/auth/social
POST/auth/registered
POST/auth/register

POST /auth/login

An API call to login customer.

Request body

emailRequiredstring

passwordRequiredstring

ReturnsAccessToken

Access token object response

curl -X POST https://api.subbly.co/storefront/v1/auth/login \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "email",
  "password": "password"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

POST /auth/otp/login

An API call to login customer by otp.

Request body

emailRequiredstring

Format: email.

tokenRequiredstring

ReturnsAccessToken

Access token object response

curl -X POST https://api.subbly.co/storefront/v1/auth/otp/login \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "customer@example.com",
  "token": "token"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

Otp Generate

POST /auth/otp

An API call to generate otp.

Request body

emailRequiredstring

Format: email.

Returnsstring

Return 200 response if otp generated

curl -X POST https://api.subbly.co/storefront/v1/auth/otp \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "customer@example.com"
}'

Response

""

POST /auth/social

An API call to login customer by social.

Request body

tokenRequiredstring

providerRequiredstring

Possible values: google, facebook.

ReturnsAccessToken

Access token object response

curl -X POST https://api.subbly.co/storefront/v1/auth/social \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "token",
  "provider": "google"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

Registered

POST /auth/registered

The API call to check if email already exists.

Request body

emailRequiredstring

ReturnsRegistered

Registered object response

registeredboolean

curl -X POST https://api.subbly.co/storefront/v1/auth/registered \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "email"
}'

Response

{
  "registered": false
}

Register

POST /auth/register

An API call to register customer.

Request body

emailRequiredstring

first_nameRequiredstring

last_nameRequiredstring

ReturnsAccessToken

Access token object response

curl -X POST https://api.subbly.co/storefront/v1/auth/register \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "email",
  "first_name": "first_name",
  "last_name": "last_name"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

Auth

Storefront Auth API endpoints

Endpoints

POST/auth/login
POST/auth/otp/login
POST/auth/otp
POST/auth/social
POST/auth/registered
POST/auth/register

POST /auth/login

An API call to login customer.

Request body

emailRequiredstring

passwordRequiredstring

ReturnsAccessToken

Access token object response

access_tokenstring

expires_ininteger

curl -X POST https://api.subbly.co/storefront/v1/auth/login \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "email",
  "password": "password"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

POST /auth/otp/login

An API call to login customer by otp.

Request body

emailRequiredstring

Format: email.

tokenRequiredstring

ReturnsAccessToken

Access token object response

access_tokenstring

expires_ininteger

curl -X POST https://api.subbly.co/storefront/v1/auth/otp/login \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "customer@example.com",
  "token": "token"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

Otp Generate

POST /auth/otp

An API call to generate otp.

Request body

emailRequiredstring

Format: email.

Returnsstring

Return 200 response if otp generated

curl -X POST https://api.subbly.co/storefront/v1/auth/otp \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "customer@example.com"
}'

Response

""

POST /auth/social

An API call to login customer by social.

Request body

tokenRequiredstring

providerRequiredstring

Possible values: google, facebook.

ReturnsAccessToken

Access token object response

access_tokenstring

expires_ininteger

curl -X POST https://api.subbly.co/storefront/v1/auth/social \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "token",
  "provider": "google"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

Registered

POST /auth/registered

The API call to check if email already exists.

Request body

emailRequiredstring

ReturnsRegistered

Registered object response

registeredboolean

curl -X POST https://api.subbly.co/storefront/v1/auth/registered \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "email"
}'

Response

{
  "registered": false
}

Register

POST /auth/register

An API call to register customer.

Request body

emailRequiredstring

first_nameRequiredstring

last_nameRequiredstring

ReturnsAccessToken

Access token object response

access_tokenstring

expires_ininteger

curl -X POST https://api.subbly.co/storefront/v1/auth/register \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "email",
  "first_name": "first_name",
  "last_name": "last_name"
}'

Response

{
  "access_token": "access_token",
  "expires_in": 7200
}

Auth

Login

Request body

ReturnsAccessToken

Otp Login

Request body

ReturnsAccessToken

Otp Generate

Request body

Returnsstring

Social Login

Request body

ReturnsAccessToken

Registered

Request body

ReturnsRegistered

Register

Request body

ReturnsAccessToken

Auth

Login

Request body

ReturnsAccessToken

Otp Login

Request body

ReturnsAccessToken

Otp Generate

Request body

Returnsstring

Social Login

Request body

ReturnsAccessToken

Registered

Request body

ReturnsRegistered

Register

Request body

ReturnsAccessToken