/get-docs/
Purpose
Users may send a UUID to return an encoded document associated to an invoice.
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 GET requests.
URI
/api_factor/get-docs/
Body Information
| Variable Name |
Type |
Required |
Purpose |
| UUID |
String |
Y |
The document's ID to be sent, the UUID is provided as a return on a store-doc call. |
Expected Return
An echo JSON object with the PDF's encoded string; Encoding Type, Content Type, and File Name.
<<<<<<< HEAD
=======
Example cURL Call
{
curl --location --request POST 'https://EXAMPLE.factorcloud.com/api_factor/GET-Docs/' \
--header 'Auth-Factorid: EXAMPLE' \
--header 'Auth-Apikey: EXAMPLE' \
--header 'Auth-SystemKey: 1' \
--header 'Content-Type: text/plain' \
--data-raw '{"UUID": "ExampleUUID"}'
}
>>>>>>> 2newcalls
Curl Example
Request:
curl -H 'Auth-FactorId: FACTORID' -H 'Auth-SystemKey: SYSTEMKEY' -H 'Auth-ApiKey: APIKEY' --get https://wstest.factorcloud.com/api_factor/get-docs/UUID.json
Response:
{
"EncodedDoc": "ExampleEncodedString",
"EncodingType": "S",
"ContentType": "application/pdf",
"FileName": "example.pdf"
}