collection.getCollection

Returns information about a collection. The information contains configuration parameters for the player and the list of collection items.

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

You can also use this method at regular time intervals to check if an uploaded document has finished converting. This could be done right after a collection.create method call. If the document's status is either complete or failed, you can stop checking its status.

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.getCollection. If it is not specified, the request will return the error code "30 - Missing mandatory parameter".

collectionHash (required)

string

The hash of the collection you wish to update. If you do not specify a collection hash, then the request will return the error code "30 - Missing mandatory parameter".

Response parameters

If the upload is successful, the API call returns information about the collection which was just created.

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.

flipbookPageCount

number

The number of pages of the collection item. For collections created with the API, collectionPageCount and flipbookPageCount should have the same value.

flipbookStatus

string

The status of the flipbook. Possible values are

processing: the document is still converting;
complete: the document was converted successfully;
failed: the conversion process failed.

Converting a PDF document is a time consuming process. You can check the status of a flipbook at a few seconds intervals by using the collection.getCollection method. The requests to collection.getCollection should be made until the flipbook has completed or failed converting.

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 player (measured in pixels).

collectionHeight

number

The embed height of the player (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 player from you.

enableDownload

boolean

If set to true, displays the download button in the player menu. The menu is displayed only when the player is in fullscreen.

enableFullScreen

boolean

If set to true, allows the player to enter fullscreen mode.

enableSearch

boolean

If set to true, displays the search button in the player 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 player. 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 player is displayed with no background.

backgroundColor

string

The background color of the player, specified as a hexadecimal value. If the transparentBackground is set to true, the player will ignore the backgroundColor parameter.

autoFlip

boolean

If set to true, allows the player 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 (DEPRECATED)

string