An External Downloader for CloudCard is any application that polls the API for photos ready to be downloaded, and saves them to another system. We have some examples of different applications that download photos from the CloudCard API.
The basic process is as follows:
- CloudCard user approves photos.
- CloudCard user views approved photos and clicks a "Download" button.
- The approved photos are then marked as "Ready for Download".
- This requires the organization to have the external download strategy. Consult your CloudCard representative if you don't know what that means.
- Your external downloader polls the server at a suitable interval, using the Photo List request with a status of
READY_FOR_DOWNLOAD
. - If the list contains photos, download each photo's bytes from the
photo.links.bytes
value in the JSON output. (This link corresponds to the Get Binary Photo Data request). - Once you have the bytes in your application, you can either write them to the file system, save them to a database, or send them to another API endpoint – whatever suits your application.
- In order to prevent your application from processing the same photo multiple times, you obviously want to mark it as downloaded. To do this, send an Update Photo request with a status of
DOWNLOADED
.
It really is that simple to write a custom photo downloader for the CloudCard API that will integrate our application directly into your workflow. And, as always, if you need assistance with developing the integration, let us know.