این اددان برای Digits قابلیت ورود به سیستم / ثبت نام با استفاده از شماره تلفن همراه را با استفاده از REST API به سایت وردپرس شما ارائه می دهد.
احراز هویت
API مبتنی بر توکن است که نسبت به روش معمولی امن تر است. همچنین از آنجا که از اعتبارنامه استفاده نمی کند ، می توانید در هر زمان دسترسی را محدود کنید.
Access Token نشانه ای است که می تواند به عنوان جایگزینی برای اعتبار کاربر برای درخواست های بیشتر ارسال شود. برای تأیید اعتبار با نشانه دسترسی ، درخواست باید با هدر ارسال شود
Authorization: Bearer access_token
توجه: اگر کاربر رمز ورود خود را تغییر داده است ، باید دوباره درخواست دسترسی را درخواست کنید.
به اعتبار Token دسترسی پیدا کنید
توکن دسترسی به طور پیش فرض 14 روز اعتبار خواهد داشت (همچنین می توانید این مورد را از تنظیمات افزونه REST API تغییر دهید) ، در صورت عدم درخواست در مدت 14 روز از برنامه ، پس مجبورید دوباره آن را درخواست کنید. اگر توکن منقضی شود ، با کد خطای 401 HTTP خطای زیر را دریافت خواهید کرد
If authorization fails, it will return 401 HTTP code
If authentication is not working you will need to add this to your .htaccess
RewriteEngine On
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
You will also need to add this to httpd.conf
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
The request should be sent as POST Parameters in Body
Registration
Endpoint: wp-json/digits/v1/create_user
Parameters
| digits_reg_name | First Name |
| digits_reg_countrycode | Country Code (with + symbol) |
| digits_reg_mobile | Mobile Phone Number |
| digits_reg_password | Password |
| digits_reg_username | Username |
| digits_reg_email | |
| otp | One Time Passcode (not for firebse and account kit gateways) |
| ftoken | Firebase ID Token if using Firebase Gateway |
| code | AccountKit authorization code if using Account Kit Gateway |
| digits_reg_{{meta_key}} | Digits Custom Fields |
Response
{“success”:true,”data”:{“access_token”:”Access Token”}}
You can use this authentication token to authenticate user (See Authentication section for more details)
{“success”:false,”data”:{“code”:”-1″,”msg”:”Error Message”}}
Login
Endpoint: wp-json/digits/v1/login_user
Parameters
| user | User’s Phone Number / Email / Username (not needed with Account Kit) |
| countrycode | Country code of Phone (with + symbol) (only needed if value of “user” is phone number) |
| password | User’s Password (not required if using OTP) |
| otp | One Time Passcode (not for firebase and account kit gateways) |
| ftoken | Firebase ID Token if using Firebase Gateway |
| code | AccountKit authorization code if using Account Kit Gateway |
Response
{“success”:true,”data”:{“access_token”:”Access Token”}}
You can use this authentication token to authenticate user (See Authentication section for more details)
{“success”:false,”data”:{“code”:”-1″,”msg”:”Error Message”}}
Forgot Password
Endpoint: wp-json/digits/v1/recovery
This can be used to reset password using email and mobile phone number both. If email is used in “user” parameter then an email with link will be sent to user for password change.
If phone number is used in “user” parameter then it will require OTP to proceed with password change request
Parameters
| user | User’s Phone Number / Email / Username |
| countrycode | Country code of Phone (with + symbol) (only needed if value of “user” is phone number) |
| otp | One Time Passcode (not for firebase and account kit gateways) (only needed if value of “user” is phone number) |
| ftoken | Firebase ID Token if using Firebase Gateway (only needed if value of “user” is phone number) |
| code | AccountKit authorization code if using Account Kit (only needed if value of “user” is phone number) |
| password | User’s New Password (only needed if value of “user” is phone number) |
Response
{“success”:true,”data”:{“access_token”:”Access Token”}}
You can use this authentication token to authenticate user (See Authentication section for more details)
{“success”:false,”data”:{“code”:”-1″,”msg”:”Error Message”}}
Logout
Endpoint: wp-json/digits/v1/logout
Response
{“success”:true}
{“success”:false}
Send OTP, Resend OTP, Verify OTP
Send OTP endpoint: wp-json/digits/v1/send_otp
Resend OTP endpoint: wp-json/digits/v1/resend_otp
Verify OTP endpint: wp-json/digits/v1/verify_otp
Parameters
All Required
| countrycode | User’s Phone number country code (with + symbol) |
| mobileNo | User’s Phone number |
| type | login (if the action is login) register (if the action is registration) resetpass (if the action is reset password) |
| 1 (only if whatsapp is being used) |
NOTE: If using Account Kit or Firebase as the gateway, you’ll also need to add their native libraries to send OTP as we will just verify them with tokens.
Response
{“accountkit”:0,”firebase”:0,”code”:”1″}
If accountkit is 1, then you need to use account kit for verification
If firebase is 1, then you need to use firebase for verification
If code is 1, then it’s a success
{“code”:”-11″,”message”:”Error Message”}