API Dashboard

Taffy 3.1.0

Resources:

verifyLoginCode DELETE PATCH PUT POST GET /verifyLoginCode

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Validate Customer

Query Params:
i) code - Type:string ; Required
ii) user_id - Type:string ; Required

Accept: NA;

optional string code
optional string user_id

users DELETE PATCH PUT POST GET /users

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Users;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Users;

updateUserInfo DELETE PATCH PUT POST GET /userUpdateInfo

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality:Update User Info;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Updated User Data;

user DELETE PATCH PUT POST GET /user

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Register User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
New User Id;
POST
Functionality:Register User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
New User Id;

uplaodImage DELETE PATCH PUT POST GET /upload_images

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Uplaod Images;

Query Params:
i) image - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;

updateGroupInfo DELETE PATCH PUT POST GET /updateGroupInfo

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality:update_groupinfo

Query Params:
i) group_image - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;

stories DELETE PATCH PUT POST GET /stories

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Likes;

Query Params:
i) story_id - Type:String ; Optional
ii) user_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post Tag;
DELETE
Functionality:Delete Story;

Query Params:
i) story_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Story;
POST
Functionality:Create stories;

Query Params:
i) user_id - Type:String ; Required
i) content - Type:String ; Required
i) is_public - Type:String ; Required
i) is_viewed - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
stories;

shopifyProductCategories DELETE PATCH PUT POST GET /shopifyProductCategories

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch collections from Shopify

checkoutBranding DELETE PATCH PUT POST GET /shopifyCheckoutBranding

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch checkout branding from Shopify

shopifyAllProducts DELETE PATCH PUT POST GET /shopifyAllProducts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch collections from Shopify
POST
Fetch collections from Shopify

searchConversation DELETE PATCH PUT POST GET /search_conversation_participants

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: - Search for Conversation Participants by name using a search term.

search DELETE PATCH PUT POST GET /search

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Search

Query Params:
i) client_id - Type:numeric ; Required
ii) search_for - Type:string ; Required (Value: Label)
iii) search_value - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Search

register DELETE PATCH PUT POST GET /register

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Validate User Credentials;

Query Params:
i) username - Type:String ; Required
ii) email - Type:String ; Required
iii) password - Type:String ; Required

Accept: NA;

Headers:
i) app_name - Type: String;
Return:
Token and session info;

profile DELETE PATCH PUT POST GET /profile

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get profile details;

Query Params:
i) client_id - Type:Numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
User Details;
PUT
Functionality:Update profile;

Query Params:
i) client_id - Type:Numeric ; Required
ii) email - Type:String ; Optional
iii) phone - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
NA;
PATCH
Functionality:Update Password;

Query Params:
i) client_id Type:Numeric ; Required
ii) current_password Type:String ; Required
iii) new_password Type:String ; Required
iv) verify_password Type:String ; Required

Accept: NA;

Headers:
i) Authorization: - Type: VARCHAR;
Return:
NA;

pinConversations DELETE PATCH PUT POST GET /pinConversations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Archive Conversations;

Query Params:
i) conversation_id - Type:String ;
ii) user_id - Type:String ;


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Archive Conversations;

notification DELETE PATCH PUT POST GET /notifications

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) notification_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Get Notifications;
DELETE
Functionality:Delete Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) notification_id Type:String: Required

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Notifications;
PUT
Functionality:Update Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) type - Type:String ; Required
iii) related_id Type:String ; Reuired
iv) read_messages Type:String: Required
v) notification_id Type:String: Required

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Notifications;
POST
Functionality:Create Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) type - Type:String ; Required
iii) related_id Type:String ; Reuired
iv) read_messages Type:String: Required

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Notifications;

message DELETE PATCH PUT POST GET /messages

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Messages by Conversation ID;

Query Params:
i) conversation_id - Type:String ; Required
ii) message_id - Type:String ; Optional
iii) sender_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
DELETE
Functionality:Delete Messages;

Query Params:
i) message_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
PUT
Functionality:Create Messages;

Query Params:
i) message_id - Type:String ; Required
ii) conversation_id - Type:String ; Required
iii) sender_id - Type:String ; Required
iv) content - Type:String ; Required
v) type - Type:String ; Required
vi) status - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
POST
Functionality:Create Messages;

Query Params:
i) conversation_id - Type:String ; Required
ii) sender_id - Type:String ; Required
ii) content - Type:String ; Required
iv) type - Type:String ; Required
v) status - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
PATCH
Functionality: Update Message Status;

Query Params:
i) message_id - Type:String ; Required
ii) status - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Message Status;

media DELETE PATCH PUT POST GET /media

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Upload Media;

Query Params:
i) userid - Type:String ; Required
i) content - Type:String ; Required
i) media - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;

lastSeen DELETE PATCH PUT POST GET /last_seen

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Last Seen;

Query Params:
i) userid - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Last Seen;
PATCH
Functionality:Add or Update Last Seen;

Query Params:
i) userid - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Last Seen;

getUsersAndGroups DELETE PATCH PUT POST GET /getusersandgroups

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Users;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Users;

product DELETE PATCH PUT POST GET /getProduct

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch simple products from WordPress API

forwardMessage DELETE PATCH PUT POST GET /forward_messages

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality: Forward Messages;

Query Params:
i) messages - Type:Array ; Required
ii) conversation_id - Type:Array ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Results of forwarded messages.

fileUpload DELETE PATCH PUT POST GET /fileUpload

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality: Upload a file to the server;

Body Params:
i) media - Type: File ; Required

Accept: multipart/form-data;

Return:
File path;

fetchOrders DELETE PATCH PUT POST GET /fetchOrders

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch orders from WooCommerce API based on customer_id
required numeric customer_id
The customer ID to fetch orders for

fcmToken DELETE PATCH PUT POST GET /fcm_token

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PATCH
Functionality:Add or Update Fcm Token;

Query Params:
i) user_id - Type:String ; Required


ii) fcm_token - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Fcm Token;

fcmNotification DELETE PATCH PUT POST GET /fcm_notification

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Send Firebase Cloud Messaging notifications to multiple devices.

fcmAccessToken DELETE PATCH PUT POST GET /fcm_access_token

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:FCM Access Token;

Query Params:
i) fcm_token - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
FCM Access Token;

favouriteProducts DELETE PATCH PUT POST GET /favouriteProducts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch Favourite Products

disappearMessages DELETE PATCH PUT POST GET /disappearMessages

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Disappear Messages;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Set Messages Disappear Duration;

socialMediaClick DELETE PATCH PUT POST GET /dashboard/socialMediaClick

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get social media clicks

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Scoail media click counts

socialMedia DELETE PATCH PUT POST GET /dashboard/socialMedia

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get social media links

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Scoail media links
PUT
Functionality:Get social media link update

Query Params:
i) client_id - Type:numeric ; Required
ii) fieldName - Type:string ; Required; (instagram, facebook, website, twitter, snapchat)
ii) fieldValue - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Social media links

serialValidationVerified DELETE PATCH PUT POST GET /dashboard/serialValidationVerified

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get serial validation verified.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Serial validation verified count and percentage data

nfcValidation DELETE PATCH PUT POST GET /dashboard/nfcValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Code validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) code - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

nfcCodeValidation DELETE PATCH PUT POST GET /dashboard/nfcCodeValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Code validation.

Query Params:
i) product_page - Type:string ; Required
ii) serial_no - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

mostRecent DELETE PATCH PUT POST GET /dashboard/mostRecent

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the most recent email list.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

labelValidation DELETE PATCH PUT POST GET /dashboard/labelValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get label validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) period - Type:string ; Optional default 'period':'weekly' hint - ('period':'weekly', 'period':'monthly')

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

codeValidation DELETE PATCH PUT POST GET /dashboard/CodeValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Code validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) code - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

currentUserFollowing DELETE PATCH PUT POST GET /current_user/following

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Current_user following;

Query Params:
i) current_user_following_id - Type:String ; required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Current_user following;

currentUserFollowers DELETE PATCH PUT POST GET /current_user/followers

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Current_user followers;

Query Params:
i) current_user_id - Type:String ; required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Current_user followers;

createOrder DELETE PATCH PUT POST GET /createOrder

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Create an order in Shopify dynamically

conversation DELETE PATCH PUT POST GET /conversations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get All Conversations;

Query Params: user_id (optional)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversations;
DELETE
Functionality:Delete Converstions;

Query Params:
i) conversation_id - Type:String ;


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversations;
POST
Functionality:Create Converstions;

Query Params:
i) conversation_type - Type:String ;
ii) name - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversations;
PATCH
Functionality: Update is_pin and is_mute status for a conversation;

Query Params:
i) conversation_id - Type:String; Required
ii) is_pin - Type:Boolean; Optional
iii) is_mute - Type:Boolean; Optional

Headers:
i) authorization - Type: String;
Return:
Status of update operation;

conversationParticipants DELETE PATCH PUT POST GET /conversation_participants

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: - Get Conversation Participants by Conversation ID OR - Get all Conversations by User ID;

Query Params:
i) conversation_id - Type:String ; Optional
ii) user_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
- If conversation_id is passed: Conversation Participants
- If user_id is passed: Conversations related to the user (participant);
DELETE
Functionality:Delete conversation participant;

Query Params:
i) participant_id - Type:String ; Required


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
conversation participant;
PUT
Functionality:Update conversation participants;

Query Params:
i) conversation_id - Type:String ; Required
i) user_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
conversation participants;
POST
Functionality:Create conversation participants;

Query Params:
i) user_id - Type:String ; Required
i) conversation_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
conversation participants;

dropdown DELETE PATCH PUT POST GET /common/dropdown

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get all dropdowns.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Drop downs data

checkProductsAvailability DELETE PATCH PUT POST GET /checkProductAvailability

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Check for Availbility of all Products.

Accept: NA;

cartPage DELETE PATCH PUT POST GET /cartPage

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch simple cart products from WordPress

cart DELETE PATCH PUT POST GET /cart

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch simple cart products from WordPress
POST
Add a product to the cart in WordPress

login DELETE PATCH PUT POST GET /authenticate

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Validate User Credentials;

Query Params:
i) email - Type:String ; Required
ii) password - Type:String ; Required

Accept: NA;

Headers:
i) app_name - Type: String;
Return:
Token and session info;

auth DELETE PATCH PUT POST GET /auth

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Validate User Credentials;

Query Params:
i) username - Type:String ; Required
ii) password - Type:String ; Required

Accept: NA;

Headers:
i) app_name - Type: String;
Return:
Token and session info;

archiveConversation DELETE PATCH PUT POST GET /archiveConversations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Archive Conversations;

Query Params:
i) conversation_id - Type:String ;
ii) user_id - Type:String ;


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Archive Conversations;
POST
Functionality:Archive Conversations;

Query Params:
i) conversation_id - Type:String ;
ii) user_id - Type:String ;


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Archive Conversations;

Products DELETE PATCH PUT POST GET /Products

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch simple products from WordPress API

Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.
Resources are listed in matching order. From top to bottom, the first URI to match the request is used.