This addon for Digits provides the functionality of login/signup using mobile phone numbers to your WordPress site using REST API.
\nAuthentication Process:
\nThe API authentication is token-based, ensuring enhanced security compared to conventional methods. By eliminating the need for user credentials, access can be restricted at any time.
\nAccess Token Usage:
\nAn Access Token serves as a substitute for user credentials in subsequent requests. To authenticate with an access token, include the following header in your request:
\nAuthorization: Bearer access_token\n\nNote: If a user changes their password, you will need to re-request the access token.
\nAccess Token Validity:
\nAccess tokens expire after 14 days of inactivity. To renew an expired token, you must request a new one. The expiry duration can be adjusted from the REST API addon settings.
\nExpired tokens result in a 401 HTTP error code, along with the following error message:
\n{\n \"success\": false,\n \"data\": {\n \"error\": \"token_expired\",\n \"message\": \"Your session has expired. Please login again\"\n }\n}\n\nError Handling:
\nIf authentication fails, a 401 HTTP error code is returned with the following error message:
\n{\n \"success\": false,\n \"data\": {\n \"error\": \"invalid_token\",\n \"message\": \"Invalid Token\"\n }\n}\n\nConfiguration:
\nFor proper authentication, add the following to your .htaccess file:
RewriteEngine On\nRewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]\n\nAdditionally, include the following in your httpd.conf file:
SetEnvIf Authorization \"(.*)\" HTTP_AUTHORIZATION=$1\n\nNote: Requests should be sent as POST parameters in the request body.
\nFirebase Gateway Integration:
\nTo utilize Firebase Gateway for OTP verification, ensure you have incorporated their native libraries. Token verification can be performed at https://jwt.io/.
\nFor further details, refer to: Firebase Documentation
\nThis information ensures a streamlined authentication process for your API integration.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37319001","collectionId":"1b43e5b7-0c9f-4b82-a474-d7609f897806","publishedId":"2sA3kbhK2q","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-31T05:11:39.000Z"},"item":[{"name":"Login","id":"37089797-e7a4-41b0-b840-4f542f2bf16b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user","value":"","description":"User’s Phone Number / Email / Username (not needed with Account Kit)
\n","type":"text"},{"key":"countrycode","value":"","description":"Country code of Phone (with + symbol) (only needed if value of “user” is phone number)
\n","type":"text"},{"key":"otp","value":"","description":"One Time Passcode
\n","type":"text"},{"key":"password","value":"","description":"User’s Password (not required if using OTP)
\n","type":"text"},{"key":"ftoken","value":"","description":"Firebase ID Token if using Firebase Gateway
\n","type":"text"}]},"url":"{{site}}/wp-json/digits/v1/login_user","description":"This endpoint facilitates user login within the WordPress environment. Users can log in by providing the necessary information through this API endpoint.
\nEndpoint: wp-json/digits/v1/login_user
First Name
\n","type":"text"},{"key":"digits_reg_countrycode","value":"","description":"Country Code (with + symbol)
\n","type":"text"},{"key":"digits_reg_mobile","value":"","description":"Mobile Phone Number
\n","type":"text"},{"key":"digits_reg_password","value":"","description":"Password
\n","type":"text"},{"key":"digits_reg_username","value":"","description":"Username
\n","type":"text"},{"key":"digits_reg_email","value":"","description":"User’s Phone Number / Email / Username
\n","type":"text"},{"key":"countrycode","value":"","description":"Country code of Phone (with + symbol) (only needed if value of “user” is phone number)
\n","type":"text"},{"key":"otp","value":"","description":"One Time Passcode (only needed if value of “user” is phone number)
\n","type":"text"},{"key":"password","value":"","description":"User’s New Password (only needed if value of “user” is phone number)
\n","type":"text"},{"key":"ftoken","value":"","description":"Firebase ID Token if using Firebase Gateway\n(only needed if value of “user” is phone number)
\n","type":"text"}]},"url":"{{site}}/wp-json/digits/v1/recovery","description":"This endpoint allows users to reset their password using either their email address or mobile phone number within the WordPress environment. Users can initiate a password reset request by providing the necessary information through this API endpoint.
\nEndpoint: wp-json/digits/v1/recovery
Usage Notes:
\nThis endpoint allows users to log out of their session within the WordPress environment. By sending a request to this API endpoint, users can expire their Access Token, effectively ending their current session and enhancing security.
\nAuthentication Requirement:
\nThis request should be sent with an Access Token. Please refer to the \"Authentication\" section for more information on Access Tokens.
\nEndpoint: wp-json/digits/v1/logout
Usage Notes:
\nUser’s Phone number country code (with + symbol)
\n","type":"text"},{"key":"mobileNo","value":"","description":"User’s Phone number
\n","type":"text"},{"key":"type","value":"","description":"login (if the action is login)\nregister (if the action is registration)\nresetpass (if the action is reset password)\nupdate (if the action is update phone)
\n","type":"text"},{"key":"whatsapp","value":"","description":"1 (only if whatsapp is being used)
\n","type":"text"},{"key":"username","value":"","description":"(for send_otp and type = register) if you want to validate and check if user exists with username before sending OTP
\n","type":"text"},{"key":"email","value":"","description":"(for send_otp and type = register) if you want to validate and check if user exists with email before sending OTP
\n","type":"text"}]},"url":"{{site}}/wp-json/digits/v1/send_otp","description":"These endpoints allow you to send and resend OTP (One-Time Password) for various user actions such as login, registration, reset password, or updating the phone number. Additionally, you can specify whether WhatsApp is being used and provide optional parameters like username and email for registration purposes.
\nSend OTP
\nEndpoint: wp-json/digits/v1/send_otp
Endpoint: wp-json/digits/v1/resend_otp
User’s Phone number country code (with + symbol)
\n","type":"text"},{"key":"mobileNo","value":"","description":"User’s Phone number
\n","type":"text"},{"key":"type","value":"","description":"update (if the action is update phone)
\n","type":"text"},{"key":"otp","value":"","description":"One Time Passcode (only if value of user is phone number)
\n","type":"text"},{"key":"whatsapp","value":"","description":"1 (only if whatsapp is being used)
\n","type":"text"},{"key":"ftoken","value":"","description":"Firebase ID Token (only needed if value of “user” is phone number, for Firebase)
\n","type":"text"}]},"url":"{{site}}/wp-json/digits/v1/verify_otp","description":"This endpoint is used to verify a One Time Passcode (OTP) provided by the user within the WordPress environment. By sending a request to this API endpoint, users can confirm the validity of the OTP for various actions such as login, registration, password reset, or phone number update.
\nEndpoint: wp-json/digits/v1/verify_otp
Usage Notes:
\nUser’s Phone number country code (with + symbol)
\n","type":"text"},{"key":"mobileNo","value":"","description":"User’s New Phone number
\n","type":"text"},{"key":"otp","value":"","description":"One Time Passcode (for verify_otp)(only if value of user is phone number)
\n","type":"text"},{"key":"whatsapp","value":"","description":"1 (only if whatsapp is being used)
\n","type":"text"},{"key":"ftoken","value":"","description":"Firebase ID Token (for verify_otp)(only needed if value of “user” is phone number, for Firebase)
\n","type":"text"}]},"url":"{{site}}/wp-json/digits/v1/update_phone","description":"This endpoint enables users to update their mobile phone number within the WordPress environment. Users can send a request with the necessary information to update their phone number securely through this API endpoint.
\nAuthentication Requirement:
\nThis request should be sent with an Access Token. Please refer to the \"Authentication\" section for more information on Access Tokens.
\nEndpoint: wp-json/digits/v1/update_phone
Usage Notes:
\nUser’s Phone number
\n","type":"text"},{"key":"countrycode","value":"","description":"Country code of Phone (with + symbol)
\n","type":"text"},{"key":"otp","value":"","description":"One Time Passcode
\n","type":"text"},{"key":"ftoken","value":"","description":"Firebase ID Token if using Firebase Gateway
\n","type":"text"}]},"url":"{{site}}/wp-json/digits/v1/one_click","description":"This endpoint enables users to perform one-click login or signup actions within the WordPress environment. It requires the One Click Login/Signup Addon to function properly. Additionally, if Firebase is being used, the Firebase ID Token (Ftoken) needs to be obtained using Firebase's SDK. For other gateways, the wp-json/digits/v1/send_otp endpoint should be called first, with the type parameter set to login.
Endpoint: wp-json/digits/v1/one_click
Usage Notes:
\nwp-json/digits/v1/send_otp endpoint first with the type parameter set to login to obtain the authorization code, and then include it in the request.