Refresh Token

URL: v3/api/refresh Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required Old token Success Response { “success”: true, “data”: {     “token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGt3uPtvQARsvo” } }

Read More

Logout

URL: v3/api/logout Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required token Success Response { “success”: true, “message”: “Successfully logged out” }

Read More

Social login redirect

URL: v3/api/social/login/redirect/{provider} Method: get Response Format: Redirect Description: Provider name has to be provided by frontend for the backend to authenticate based on the given provider. Parameters: None

Read More

Social login

URL: social/login/{provider} Method: get Response Format: JSON Description: Gets redirected by the provider to this route, which in change redirects to ‘/social/auth?token=’, from which token has to be obtained. Parameters: None

Read More

Active Social Login Providers

URL: v3/api/active-providers Method: GET Response Format: JSON Description: Gets a list of active social logins Parameters: None Response: { “Success”:true, “Data”: {“providers” :[‘google’, ‘facebook ’] }}

Read More

Forgot Password

URL: v3/api/password/email Method: post Response Format: JSON Description :  Sends set password link to the given email ID if that email is register Parameters: Name Data Type Required / Optional Description email String Required Password reset token which is sent as email Response: {    “success”: true,    “message”: “We can’t find a user with that email […]

Read More

Get user by token

URL: v3/api/get-user-by-token Method: GET Response Format: JSON Description : In case of social login, it is only token that has sent to the frontend. So this API provides user details after giving that token. Parameters: Name Data Type Required / Optional Description token String Required token Success Response: { “success”: true, “data”: {     “user”: […]

Read More

Knowledge base API’s

1. Search URL: v3/api/search Method: get Response Format: JSON Description: Searches for articles in the knowledge base Parameters: Name Data Type Required / Optional Description s String Required The string that user wants to search token String Optional If the token is provided, backend considers that as logged in user, else guest  Success Response:   […]

Read More

Billing API

Description: Checking billing access to the URL. API checks if the customer has purchased the pro app URL:  v3/api/check-url          (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description api_key String Optional An alphanumeric code that can be used to authenticate your API calls url String […]

Read More

FCM API

Description: Sends the FCM token to the app server. This API enables push notification feature. URL: api/v3/helpdesk/fcmtoken         (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description id Integer Required Id of the user os string Optional OS type fcm_token string Required Token of the device […]

Read More