1. Auth
Salla Platform Docs
  • Languages
  • Notify
  • Event
  • Storage
  • Configuration
  • Forms
  • Helpers
  • Overview
  • Auth
    • Login
    • Logout
    • Verify
    • Resend
    • Register
    • Refresh
  • Cart
    • Latest
    • 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
    • Quick Add
    • Add Item
    • Details
  • Wishlist
    • Add
    • Remove
    • Toggle
  • Loyalty
    • Get Program
    • Exchange
    • Reset
  • Comment
    • Add Comment
    • Fetch
    • Get Page Comments
    • Get Product Comments
  • Metadata
    • Metadata Details
  • Profile
    • Update profile
    • Update contact
  • Product
    • Get price
    • Fetch Options
    • Product availability
    • Categories
    • Offer details
    • Search products
    • Get Gift Details
    • Add Gift To Cart
    • Upload Gift Image
    • Get Product Details
    • Fetch
    • Size Guides
  • Booking
    • Add
  • Rating
    • Order
    • Store
    • Products
    • Shipping
  • Currency
    • Change
    • List
  • Order
    • Create cart from order
    • Cancel
    • Send invoice
    • Show order
  • Component
    • Reviews
    • Menus
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Salla - Opensource
Salla - Developers Community
  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

Response#

Success
Error
auth.login.success

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 2026-07-09 11:27:26
Previous
Overview
Next
Logout