Downloading Photos from CloudCard

An External Downloader for CloudCard is any application that retrieves photos from the API that are ready to be downloaded and saves them to another system. Several options are available for performing this integration.

Approved photos can be manually downloaded by clicking the "Download Photos" button. This will package up all currently approved photos into a zip file, download it to your computer, and move the photos to the Downloaded queue.

This process can be automated. CloudCard support staff must configure your organization to support automated photo downloading. This is a manual configuration step that only needs to be performed once, at which photos can be downloaded via the following process:

  • Card office user approves photos, which gives the photos the APPROVED status.

  • (optional) CloudCard user views approved photos and clicks a "Download" button, which gives the photos the READY_FOR_DOWNLOAD status.

  • Your code should subscribe to a Status Queue connected to the APPROVED or READY_FOR_DOWNLOAD status (or any other appropriate status) and download photos. 

  • When messages are received from the queue, download each photo's binary file 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 should delete the message from the Status Queue in order to prevent your application from processing the same photo multiple times. 

This logic has already been implemented in an open-source project, the CloudCard Photo Downloader, which we maintain and support. You are welcome to set it up yourself or simply reference the code.