Obtaining an API key

All API requests should include an apiKey as a url parameter.

Example:
/api/issue/123?apiKey=6031cc6f0be82a4de9d01b008605edc6cd6d98a3dc119c

You can obtain an API key by creating an API user in your 3D Issue account or by contacting 3D Issue Developer support.

Partner clients can create an API user through their admin dashboard.

Flipbooks structure overview

Flipbook account are organised in the following structure:

Brands (An organisational unit or client)

Publications (A category or series of issues)

Issues (A Flipbook, containing settings and a collection of pages)

Issue creation overview

The standard steps of creating an issue are as follows. These points are expand further in the page.

1. Obtain your brand id.
2. Obtains your publication id.
3. Create an issue by uploading a PDF to your /brand/publication
4. After uploading the PDF, the issue goes into a preparing process. This prepares the pages and analyses the PDF. The client monitors this through the status api.
5. When the preparing process is complete, the issue can be customised.
6. After customisation the issue can be processed & published. The client monitors this through the status api.
7. Once publishing is complete the issue link is available.

Obtaining Brand(s)

Brands cannot be created by clients, basic customisation and listing is available through the api.

You can list the brands available to your account with

GET /api/brand/brandsForUser

Obtaining Publication(s)

You can list the publications for a brand with

GET /api/publication/brand/{brandId}

Creating an issue(Flipbook)

Step 1:

POST /api/processPublication/upload/{brandId}/{publicationId}

Form-data should include the parameter “file” which is the File(pdf) to upload.

Response includes the new issueId

Step 2:

Watch Flipbook prepare process.

GET /api/processPublication/status/{brandId}/{issueId}

Returns status of the flipbook preparations.

Step 3:

Customise issue. (Backgrounds, colors, features etc). See API reference for customisation options

Step 4:

Publish Flipbook

GET /api/processPublication/process/{brandId}/{publicationId}/{issueId}

Step 5:

Watch publish process:

GET /api/processPublication/status/{brandId}/{publicationId}

Step 6:

After publish process completes, you can obtain info about the issue from:

GET /api/issue/{issueId}

response.magazineLink contains the web link to the issue.