The core features of the API are:
\nWith the basic features above you can basically build a Linktree clone or at least the base features.
\nThere are no rate limits set yet.
\nBased on simple REST principles, this Web API endpoints return JSON metadata about users and links directly from the Database.
\nThe Web API is based on REST principles. Data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint. Where possible, Web API uses appropriate HTTP verbs for each action:
\nWeb API returns all response data as a JSON object. See the Web API Object Model for a description of all the retrievable objects.
\nApart from the response code and error codes, unsuccessful responses return a JSON object containing the following information:
\nCreates/Adds a new User
\nJSON Data
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains a Auth object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\nNote: The token value in a successful response would be used as a Bearer token value in your Authorization header.
\n","urlObject":{"port":"5000","path":["auth","signup"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff4abf2e-1b0e-47d0-b0ec-132a9b55f57e"},{"name":"Login","id":"ee17847e-375c-40be-8cd2-02a85ffecb40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test@gmail.com\",\r\n \"password\": \"@Passwordtest1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"127.0.0.1:5000/auth/login","description":"Authenticates a user.
\nJSON Data
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains a Auth object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\nNote: The token value in a successful response would be used as a Bearer token value in your Authorization header.
\n","urlObject":{"port":"5000","path":["auth","login"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee17847e-375c-40be-8cd2-02a85ffecb40"}],"id":"59d9a877-3d7a-4538-b3b7-9f27c4d2fe79","description":"To make certain actions i.e Edit/Update/Delete a user needs to be logged in or authorized. This section show how to authorize a user.
\nGets user info
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains a User object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Edits/Updates the current authenticated user's info
\nJSON Data
\nNote: If these fields are null, no changes would be made
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains a User object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Deactivates the current authenticated user
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains an empty object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Every user need a means to get/edit/update their information. This section enlightens you on how to go about that.
\nGets link info
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains a Link object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Adds a Link to the current authenticated user's tree.
\nJSON Data
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains a Link object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Updates the link with the path-parameter public_id info.
JSON Data
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains a Link object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Removes a Link from a user's tree.
\nOn success, the HTTP status code in the response header is 200 OK and the response body contains an empty object in JSON format.
\nOn error, the header status code is an error code and the response body contains an error object and an error code possible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This section would enable you make requests to create/edit/update/delete links for a persons tree.
\n