gif

/orders/<order number>/gif

Gif files have two advantages over other formats. First, gif format is the most commonly known animation software format, requiring no complex or hardware enabled codecs. As a result, gif files are displayable by almost any software and is arguably the most universally readable animated file format. Gif also supports transparency. Gif files have several disadvantages over other formats; they are slow to create, the final file size is very large for the length of time shown, and the timing of the playback is imprecise.

gif

This resource returns the complete animated gif binary stream. Gif is the most slowly completed format of the animation formats provided by ACME. Therefore, it is always recommended to query orders/[OrderNumber]/progress resource first, and after progress has reached a value of 100, then request the gif file. Example URL:

https://api.acme.codes/orders/1444979323_ODFAUQSE/gif

gif/[timestamp]

This resource is an alias to /orders/[#]/gif. This is a convenience resource which is helpful in some programmatic circumstances to bypass the caching mechanism of client-side frameworks. By putting any timestamp (TS) value after gif, the client code is forced - through this resource alias - to always get the latest /orders/[#]/gif. Example URL:

https://api.acme.codes/orders/1444979323_ODFAUQSE/gif/1464382911

gif-file

This resource returns the same gif stream as the above, but when called from within a browser, a “File Save As..’ dialog box will appear asking the user where they would like to download the remote file to. Example URL:

https://api.acme.codes/orders/1444979323_ODFAUQSE/gif-file

gif-file-info

This resource returns a JSON-formatted response containing a ‘fileSize’ key:value pair. The value of fileSize is zero until the file creation is completed, at which point it is permanently the file size of the finished gif animation file. Example URL:

https://api.acme.codes/orders/1444979323_ODFAUQSE/gif-file-info

Example return value:

{"fileSize":  1148656}