A Generic Independent file/document uploading component that can be integrated with any application in a secure way.
-
URL
-
Method
POST
-
URL Params
Required:
name=[alphanumeric]
email=[alphanumeric]
password=[alphanumeric]
Optional:
organization=[alphanumeric]
-
Data Params
If making a post request, what should the body payload look like? URL Params rules apply here too.
-
Success Response
- Code: 200
Content:{ message : "Success", Authkey : AUTH4kjkakfjjaejfjajk2324 }
- Code: 200
-
Error Response:
Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. All of those should be listed here. It might seem repetitive, but it helps prevent assumptions from being made where they should be.
-
Code: 401 UNAUTHORIZED
Content:{ error : "Log in" }
AND
-
Code: 422 UNPROCESSABLE ENTRY
Content:{ error : "Email Invalid" }
-
-
URL
-
Method
POST
-
URL Params
Required:
author=[alphanumeric]
documentfile=[file]
width=[integer]
height=[integer]
authkey=[alphanumeric]
password=[alphanumeric]
appname=[alphanumeric]
Optional:
quality=[alphanumeric]
-
Data Params
If making a post request, what should the body payload look like? URL Params rules apply here too.
-
Success Response
- Code: 200
Content:{ message : "success" , DocId : DOC394890280934809 }
- Code: 200
-
Error Response:
Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. All of those should be liste d here. It might seem repetitive, but it helps prevent assumptions from being made where they should be.
-
Code: 401 UNAUTHORIZED
Content:{ error : "email or password not match." }
AND
-
Code: 422 UNPROCESSABLE ENTRY
Content:{ error : "Input not valid." }
-
-
URL
-
Method
GET
-
URL Params
Required:
authkey=[alphanumeric]
password=[alphanumeric]
-
Data Params
If making a post request, what should the body payload look like? URL Params rules apply here too.
-
Success Response
- Code: 200
Content: File
- Code: 200
-
Error Response:
Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. All of those should be liste d here. It might seem repetitive, but it helps prevent assumptions from being made where they should be.
-
Code: 401 UNAUTHORIZED
Content:{ error : "Email or Password is invalid or you are not authorized to access this file" }
OR
-
Code: 422 UNPROCESSABLE ENTRY
Content:{ error : "inputs are not valid" }
-