Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Auth
  • Languages
  • Notify
  • Event
  • Overview
  • Storage
  • Configuration
  • Forms
  • Helpers
  • Auth
    • Login
    • Logout
    • Verify
    • Resend
    • Register
    • Refresh
  • Cart
    • Latest
    • Details
    • Quick Add
    • Add Item
    • Delete Item
    • Delete Image
    • Add Coupon
    • Remove Coupon
    • Get Upload Image
    • Get Quick Order Settings
    • Create Quick Order
    • Order Status
    • Get Current Cart Id
    • Price Quote
  • Wishlist
    • Add
    • Remove
    • Toggle
  • Loyalty
    • Get Program
    • Exchange
    • Reset
  • Comment
    • Add Comment
    • Fetch
    • Get Page Comments
    • Get Product Comments
  • Profile
    • Update profile
    • Update contact
  • Product
    • Get price
    • Product availability
    • Categories
    • Offer details
    • Search products
    • Get Gift Details
    • Add Gift To Cart
    • Upload Gift Image
    • Get Product Details
    • Fetch
    • Fetch Options
    • Size Guides
  • Order
    • Create cart from order
    • Cancel
    • Send invoice
    • Show order
  • Booking
    • Add
  • Rating
    • Order
    • Store
    • Products
    • Shipping
  • Currency
    • Change
    • List
  • Component
    • Reviews
    • Menus
  1. Auth

Login

In general, the authentication API allows a developer to control all aspects of a user's identity. It has endpoints for logging in, logging out, and using APIs, among other things. This login endpoint is used to authenticate a user. Either the email or the phone number can be used as a login identifier, which means that the user has two types of login process, email and phone.
TIP
The login endpoint has been implemented in the Login Web Component, and It's all setup to save developer's time and effort.

Payload#

auth.login.payload
phone
string 
LoginByMobilePayload.phone
required
The phone number of the user, which is used for login.
email
string 
required
The email of the user, which is used for login.
type
enum<string> 
LoginByMobilePayload.type
required
The login type, which can be either the user's email or phone.
Allowed values:
mobileemail
country_code
string 
LoginByMobilePayload.country_code
required
The user country code.
Example:
SA

Response#

Success
Error
auth.login.success
success
boolean 
success
required
Response flag
status
enum<number> 
status
required
Allowed values:
200201202
data
object 
data
required
Response data.
verification
object 
required
The access verification type and status.

Usage#

Mobile
Email
In the case of using the phone number as a login type, the developer can use the example below to receive the data, and redirect the user accordingly.

Events#

The login process may trigger two events during the login process, onCodeSent and onCodeNotSent.

onCodeSent#

This event will be triggered when the login process is completed successfully and the loing code has been sent.

onCodeNotSent#

This event will be triggered when a failure occurs in receiving and setting the access code.
Modified at 2025-03-04 12:54:02
Previous
Auth
Next
Logout