Description: Authenticates a user and gives his/her profile information back if successful. URL: v3/api/login Method: POST Response Format: JSON Parameters : Name Data Type Required / Optional Description user_name String Required Username of the Agent password String Required Password of the Agent Success Response : { “success”: true, “data”: { “token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGkvbG9naW4iLCJpYXQiOjE1MTg2MDI1NTAsImV4cCI6MTUxODYwMjc5MCwibmJmIjoxNTE4NjAyNTUwLCJqdGkiOiJpTjFMSkl5M0U2UXB5aUpaIn0.QrXxRYlowT4v2BayTNvapnHUe1vMJ_NlXydgJoS7y1E”, “user”: […]
Articles Tagged: v3
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” } }
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” }
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
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
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 ’] }}
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 […]
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”: […]
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: […]
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 […]