collection.downloadHTML

Starts generating the download package and returns the progress status. When the status is complete it also returns the resource url.

Note:

• requests must be made to https://api.flipsnack.com/v1

• this method is not available while the flipbook is in the processing state

Request parameters

Name	Type	Description
apiKey (required)	string	The API key provided for your user. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". If the key is incorrect the request returns the error code "41 - Invalid credentials".
signature (required)	string	The signature must be calculated by you and added to the request. See How to sign a request for more information. If the parameter is missing the request will return the error code "30 - Missing mandatory parameter". If the signature is incorrect the request will return the error code "44 - Invalid signature".
action (required)	string	The API method that should be called. In this case the value should be collection.getStats. If it is not specified, the request will return the error code "30 - Missing mandatory parameter".
collectionHash (required)	string	The hash of the flipbook for which you want the download package. If you do not specify a flipbook hash, then the request will return the error code "30 - Missing mandatory parameter".

Response parameters

Name	Type	Description
status	string	The status of the download package. Possible values are PROCESSING: the request is being processed; COMPLETE: the package has been successfully generated; FAILED: the package could not be generated Generating a download package is a time consuming process. You can check the status at a few second intervals by using the collection.downloadHTML method. The requests to collection.downloadHTML should be made until the download package is generated. If the download package is already generated when the first request to collection.downloadHTML is made, the COMPLETE status will be returned.
resourceUrl	string	The url for the download package. The url will expire after one minute due to security reasons.

Error codes

For complete list of error codes and messages go to API status codes section.

Examples

Request

cURL

# GET   
curl -X GET \
     -G \
     https://api.flipsnack.com/v1/ \
     -d action=collection.downloadHTML \
     -d apiKey=<YOUR-API-KEY> \
     -d collectionHash=d3m0h45h \
     -d signature=<YOUR-REQUEST-SIGNATURE>

HTML

Response

JSON

{
    "code": 20,
    "status": "OK",
    "data": {
        "status": "COMPLETE",
        "resourceUrl": "https://cdn.flipsnack.com/sample-path/to-html.zip",
    }
}