/store-docs/
Purpose
Users may send an encoded document for storage.
Header Information
The following Authorization keys need to be added to any API call header.
Auth-FactorID: an ID provided by FactorCloud to the Factor who owns the instance of FactorCloud.
Auth-SystemKey: A Key to Identify the specific system.
Auth-APIKey: An API password.
HTTP Methods
Accepts POST requests.
URI
/api_factor/store-docs/
Body Information
| Variable Name |
Type |
Required |
Purpose |
| EncodedDoc |
String |
Y |
The document to be sent, encoded in the manner specified below. |
| EncodingType |
String |
Y |
The type of encoding the document is in, may be Binary ‘B’, Base64 Encoded ‘S’, or Encrypted ‘E’ |
| ContentType |
String |
Y |
Marks which type of file the encoded document is, only ‘application/pdf’ is supported. |
| FileName |
String |
Y |
The name of the encoded document |
Expected Return
An echo JSON object with the PDF byte length; filename, and uuid for future recall.
Curl Example
Request:
<<<<<<< HEAD
curl -H 'Auth-FactorId: FACTORID' -H 'Auth-SystemKey: SYSTEMKEY' -H 'Auth-ApiKey: APIKEY' --data '{"EncodedDoc":"ExampleEncodedString","EncodingType":"S","ContentType":"application/pdf","FileName":"example.pdf"}' https://wstest.factorcloud.com/api_factor/store-docs/
=======
{
curl --location --request POST 'https://EXAMPLE.factorcloud.com/api_factor/Store-Docs/' \
--header 'Auth-Factorid: EXAMPLE' \
--header 'Auth-Apikey: EXAMPLE' \
--header 'Auth-SystemKey: 1' \
--header 'Content-Type: text/plain' \
--data-raw '{"EncodedDoc": "ExampleEncodedString","EncodingType": "S","ContentType": "application/pdf","FileName": "example.pdf"}'
}
>>>>>>> 2newcalls
Response:
Header for updated stored document: Status OK 200
Header for newly stored document: Status Created 201
{
"message": "200"
}