Deletes a flipbook from an existing collection.
Note: Requests must be made to https://api.flipsnack.com/v1.
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 flipbook.delete. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". |
collectionHash (required) | string | The hash of the collection to which the flipbook belongs. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". |
flipbookHash (required) | string | The hash of the flipbook that will be removed. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". |
format | string | The format of the response from the server. Possible values are json, jsonp and xml. If you set format to jsonp, you must also specify the callback parameter. Default: json. |
callback | string | The name of the callback function used for the jsonp response. This parameter is required if format is set to jsonp. Otherwise it is ignored. |
If the request is successful, The API does not send back data. It only responds with status code "20 - OK".
Code | Message | Explanation |
30 | Missing mandatory parameter | The request does not contain one or more required parameters. There are at least 3 required parameters for every request: apiKey, signature and action. Other methods may also have extra mandatory parameters. Please check the API Reference for more information. |
31 | Requests per second limit exceeded | There were too many requests per second made with the same API key. |
32 | Requests per minute limit exceeded | There were too many requests per minute made with the same API key. |
40 | Bad request |
|
41 | Invalid credentials | The API key provided in the request is invalid. |
42 | Invalid action | The API method you specified in the request is incorrect. Please see the API Reference for the list of possible methods. |
43 | Forbidden | You are not allowed to access the specified collection: it has been deleted or the collection belongs to another user. |
44 | Invalid signature | The signature you provided is incorrect - it does not match the request. |
46 | Invalid collection hash | You are trying to access a collection that does not exist. |
47 | Invalid flipbook hash | You are trying to access a flipbook that does not exist. |
HTML form example
Curl example
curl -F "action=flipbook.delete"\-F "apiKey=LK12NS-0-IOBW3S89VVJH12Z"\-F "collectionHash=d3m0h45h"\-F "flipbookHash=da8637256a0276f13999204f5f1i462s"\-F "signature=2298a6456c1dd2d12b895ce4688ffe31"\https://api.flipsnack.com/v1/
Responses
JSON
{"code": 20,"status": "OK"}
JSONP
callbackFunctionName({data});// callbackFunctionName is the function name specified by the callback parameter, in the request// the {data} is the actual JSON response