Flipsnack API

collection.deleteLogo

Deletes the logo image of the specified collection.

Note: Requests must be made to http://api.flipsnack.com/v1.

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.deleteLogo. If it is not specified, the request will return the error code "30 - Missing mandatory parameter".
collectionHash (required) string The hash of the collection from which the logo image will be removed. If it is not specified, the request will return the error code "30 - Missing authentication".
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.

Response parameters

If the request is successful, the API call returns information about the specified collection.

Name Type Description
collectionHash string The hash for the newly created collection. If the collection status is editable the generated hash will be temporary. Once the collection is published, a new, final hash will be generated for it.
collectionTitle string The title of the collection.
collectionDescription string The description of the collection. It can be specified in the creation parameters or generated by the conversion system.
collectionStatus string The current status of the collection: public, editable or unlisted.
coverImage string The url of the collection's thumbnail image. This thumbnail is generated from the first page of the first collection item.
collectionPageCount number The number of pages in the collection, for all the collection items.
createdDate date The date when the collection was created (not necessarily published).
publishDate date The date when the collection was published.
directLink string The public link of the collection.
settings object An object containing the configuration parameters of the collection, as set from the API call. See the list below.
collectionItems array The list of collection items belonging to the collection. In case of collections created using the API, the list contains a single item.

The parameters of the collection item are listed below.

Configuration parameters

Name Type Description
collectionWidth number The embed width of the widget (measured in pixels).
collectionHeight number The embed height of the widget (measured in pixels).
collectionStatus string The type of collection. Possible values are public, editable and unlisted.

Public collections are listed on your public profile and in search results. They are publicly available to other users.

Editable collections are not published. They must be published manually from the Flipsnack editor or updated using the collection.update method.

Unlisted collections are published but not listed on your profile page and in search results. Other users may view them only if they receive a direct link or an embedded widget from you.
enableDownload boolean If set to true, displays the download button in the flash widget menu. The menu is displayed only when the widget is in fullscreen.
enableFullScreen boolean If set to true, allows the Flash widget to enter fullscreen mode: a "Click to read" button is displayed.
enableSearch boolean If set to true, displays the search button in the flash widget menu. If there is no text to search within the current collection item, the search button is displayed as disabled.
tooltipsLanguage string Selects the language for the tooltips displayed in the flash widget. Possible languages are: Basque, Bosanski, Català, Czech, Dansk, Deutsch, English, Español, כשר, Française, ελληνικά, Hrvatski, Indonesian, Italiano, Magyar, Nederlands, Nederlands, Norsk, Polski, Português, Português do Brasil, Română, Pусский, Cрпски, Slovene, Suomi, Slovak, Swedish, Turkish.
transparentBackground boolean If set to true, the widget is displayed with no background. When embedding Flash widgets, make sure that the wmode parameter of the embed tag is set to 'transparent'.
backgroundColor string The background color of the widget, specified as a hexadecimal value. If the transparentBackground is set to true, the widget will ignore the backgroundColor parameter.
backgroundScaleType string The scale mode of images used as background for the widget. Possible values are scaleCrop, center and tile. Background images can be set using the collection.setBackgroundImage method.
autoFlip boolean If set to true, allows the widget to automatically turn the pages of the flipbook. The pages turn after a time specified by the autoFlipDelay parameter.
autoFlipDelay number Specifies the time in seconds for pages to turn automatically. If autoFlip is false, this parameter is ignored.
rightToLeftOrientation boolean If set to true, allows the flipbook to be viewed from right to left: the first page is starts from the end as viewed in normal mode. This option is useful for documents written in right to left languages.
singlePageView boolean If set to true, allows the flipbook to be viewed a single page at a time.
logoUrl string The URL of the logo image. A logo image can be set only by uploading it with the collection.setLogo method.
shareFacebook boolean If set to true, the Flash widget displays a Facebook sharing option in the widget menu, in fullscreen mode.
shareTwitter boolean If set to true, the Flash widget displays a Twitter sharing option in the widget menu, in fullscreen mode.
shareGooglePlus boolean If set to true, the Flash widget displays a Google+ sharing option in the widget menu, in fullscreen mode.
sharePinterest boolean If set to true, the Flash widget displays a Pinterest sharing option in the widget menu, in fullscreen mode.
shareEmail boolean If set to true, the Flash widget displays an email sharing option in the widget menu, in fullscreen mode.
shareLinkText string The link opened from the link sharing option, within the widget. By default, this link is the direct link of the collection.

Collection item (flipbook) parameters

.
Name Type Description
flipbookHash string The hash generated for the collection item.
flipbookPageCount number The number of pages of the collection item.
flipbookTitle string The title of the flipbook.
flipbookDescription string The description of the flipbook.
extension string The extension of the document that the flipbook is based on. Extensions can be pdf, jpg or png.
convertStatus string The status of the flipbook specifies if it has finished converting or if it is still in the process of conversion. Possible values are PROCESSING, FAILED and COMPLETE.

Error codes

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
  • You made a POST request for an API call that is not uploading files.
  • You made a GET request for an API call that uploads files.
  • Your request is incorrectly formatted or the URL is invalid.
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.

Example

HTML form example

<form method="get" action="http://api.flipsnack.com/v1/">
    <input type="hidden" name="action" value="collection.deleteLogo">
	<input type="hidden" name="apiKey" value="LK12NS-0-IOBW3S89VVJH12Z">
	<input type="text" name="collectionHash">
    <button type="submit">Submit</button>
</form>

Curl example

curl -F "action=collection.deleteLogo"\
     -F "apiKey=LK12NS-0-IOBW3S89VVJH12Z"\
     -F "collectionHash=d3m0h45h"\
     -F "signature=2298a6456c1dd2d12b895ce4688ffe31"\
     http://api.flipsnack.com/v1/

Responses

<?xml version="1.0" encoding="utf-8"?>
<response>
    <code>20</code>
    <status>OK</status>
    <data>
        <collectionHash>d3m0h45h</collectionHash>
        <collectionTitle>Lorem ipsum</collectionTitle>
        <collectionStatus>published</collectionStatus>
        <collectionItems>
            <collectionItem>
                <flipbookHash>7c5e600d4459fe4e04d23ae5ei188777</flipbookHash>
                <flipbookTitle>Lorem ipsum</flipbookTitle>
            </collectionItem>
        </collectionItems>
        <settings>
            <logoImage></logoImage>
            <logoUrl></logoUrl>
        </settings>
    </data>
</response>
{
    "code": 20,
    "status": "OK",
    "data": {
        "collectionHash": "d3m0h45h",
        "collectionTitle": "Lorem ipsum",
        "collectionStatus": "published",
        "collectionItems": [
            {
                "flipbookHash": "7c5e600d4459fe4e04d23ae5ei188777",
                "flipbookTitle": "Lorem ipsum"
            }
        ],
        "settings": {
            "logoImage": "",
            "logoUrl": ""
        }
    }
}
callbackFunctionName({data});
// callbackFunctionName is the function name specified by the callback parameter, in the request
// the {data} is the actual JSON response