Download document through API V8

[femoz]

Hi,

is it possible to download document through API V8?

Thank you

Jan Opravil

[John]

Hey,

As far as I’m aware, there isn’t an Out of the box API endpoint to download a document

There is an entrypoint, in the format of:
entryPoint=download&id=[record id]&type=[module type]

So, eg, navigating to:
https://my.crm.com/index.php?entryPoint=download&id=f1f2f7b0-5785-b826-b11a-603faf08e6b6&type=Documents
Would download a document record with the ID “f1f2f7b0-5785-b826-b11a-603faf08e6b6”

Though I’m not sure if thats totally suitable for API work, or what you’d like to achieve

You might be able to create a custom endpoint for the API, that then uses this entrypoint.
(Though I don’t have much knowledge on that front, im afraid)

Some links for this:

Customization

API V8 Custom Endpoint

As I couldn’t find any info on how to get some custom endpoints up and running, I thought I’d share back here. My install is in /opt/suitecrm so change that as needed. Make sure composer is installed - https://getcomposer.org/download/ cd /opt/suitecrm php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" php -r "if (hash_file('sha384', 'composer-setup.php') === '48e3236262b34d30969dca3c37281b3b4bbe3221bda826ac6a9a62d6444cdb0dcd0615698a5cbe587c3f0fe57a54d8f5') { echo 'I…

There is also a post on the SugarCRM dev hub: https://sugarclub.sugarcrm.com/dev-club/f/questions-answers/460/how-do-i-force-a-download-from-api
However, I’m not sure how applicable this would be nowadays, as the API methods could differ greatly

Unless any other user has a quick tip for this?