The cShare REST API provides endpoints for
\nThe CRUD operations on the database, are secured by a JWT, which is uniquely generated for every user.
\nhost: the IP address or domain where the cShare-server will be running. If running locally, it will be localhost.JWT_Token: This token will be returned by User/Login request after a successful login.Endpoint for registration of new users.
\n\n\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b9ef348e-b0cf-4574-af44-a308f873561d","id":"b9ef348e-b0cf-4574-af44-a308f873561d","name":"User","type":"folder"}},"urlObject":{"path":["v1","users","signup"],"host":["localhost:5675"],"query":[],"variable":[]}},"response":[],"_postman_id":"05d86fde-f44c-4fac-ae8e-31400220ea8b"},{"name":"Login","id":"8fef35de-348c-4250-ba2b-01a403dc9127","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"jammutkarsh\",\n \"password\": \"passalulaword\",\n \"pCount\": 8,\n \"spCount\": 13\n}","options":{"raw":{"language":"json"}}},"url":"localhost:5675/v1/users/login","description":"NOTE: It doesn't return any JWT
\n
The endpoint generates JSON Web Token (JWT)
\nThese endpoints are for authentication and authorization purposes. The endpoints are:
\nSignUp: For new users. It returns the status of user creation.Login: For registered users with valid credentials. It returns a JWT as a response.These endpoints follow a non-traditional approach to user access control. Salt(a random string) is added to the password with some additional information like pCount (Password Count) and spCount (Salted Password Count) to avoid malicious activity. These are uniquely generated by the client system.
For the testing of the API, this can be generated by running the example code to get values to be filled in JSON.
\n$ go run examples/example.go\nEnter username: username1234\nEnter password: password5678\nusername1234\npassworisorialrd5678\n12\n20\n\nThe JSON equivalent of above output is
\n{\n \"username\": \"username1234\",\n \"password\": \"passworisorialrd5678\",\n \"pCount\": 12,\n \"spCount\": 20\n}\n\nEndpoint to post clip data on the server
\nNOTE: The key pair value of \"secret\": false is for a upcoming feature. It's value should always be false.
Endpoint to get a single clip for a user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint to get a all the clip for a user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint to delete a all the clip of a user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The endpoints under clips are secured by a JSON Web Token, or JWT. For anyone to access these resource endpoints, they need a valid JWT.
\nEvery JWT is unique. It depends on two factors.
\nYou can generate a JWT from User/Login endpoint. Save this token in this collection's variable section to ease the testing of APIs.
The following endpoints for clip operations are:
\nPostClip: Adds clip data to the database.GetSingleClip: Fetches a single clip from the database. (default: last clip)GetAllClip: Fetches all the clips from the database.DeleteAll: Clears all the data from the database.