Data Structures

Description

A description of the cover that will be generated by calling this API.

Example

This is a sample JSON-formatted Cover object

{
"cover": {
  "templateId" : "6x9paperback",
  "spineWidth" : 72,
  "layoutBlocks" : {
    "frontCoverHeadline" : {
      "backgroundColor" : "#229999",
      "textColor" : "#000000",
      "text" : "A story of intrigue, mystery and misbehavior"
    },
    "title" : {
      "backgroundColor" : "#229999",
      "textColor" : "#000000",
      "text" : "Revenge of the Albatross and more stories"
    },
    "author" : {
      "backgroundColor" : "#229999",
      "textColor" : "#000000",
      "text" : "Carl Mabry"
    },
    "spineAuthor" : {
      "backgroundColor" : "#C0C0C0",
      "textColor" : "#000000",
      "text" : "Carl Mabry"
    },
    "spineLogo" : {
      "image" : "http://cfl.uploads.mrx.ca/ham/images/newser/2009/08/BobYoung5725.jpg"
    },
    "frontFlapText" : {
      "backgroundColor" : "#808080",
      "textColor" : "#000000",
      "text" : "Lulu (Lulu Enterprises, Inc. and Lulu Press, Inc. are collectively called \"Lulu\") is a company offering diverse publishing and printing services with headquarters at Raleigh, North Carolina, United States. The company is international with staff in 12 countries, and offices in Raleigh, London, Toronto and Bangalore.[1] In addition to printing and publishing services it also offers online order fulfillment. The brand name is derived from the concept of a lulu as an old-fashioned term for a remarkable person, object, or idea. [2] The company's CEO is Red Hat co-founder Bob Young. Authors who publish/print materials and similar works through Lulu retain the copyrights to such materials and similar works. Optional services offered by the company include ISBN assignment, and distribution of books to retailers requesting specific titles (returns are not accepted, which limits distribution to physical bookstores). Electronic distribution is also available. Lulu Enterprises was founded in early 2002. OpenMind Publishing, founded by Bradley Schultz and Paul Elliot, merged its publishing company and staff with Lulu in the latter part of 2002. OpenMind Publishing was a publisher of customized texts for college professors. "
    },
    "backFlapText" : {
      "backgroundColor" : "#C0C0C0",
      "textColor" : "#000000",
      "text" : "Lulu (Lulu Enterprises, Inc. and Lulu Press, Inc. are collectively called \"Lulu\") is a company offering diverse publishing and printing services with headquarters at Raleigh, North Carolina, United States. The company is international with staff in 12 countries, and offices in Raleigh, London, Toronto and Bangalore.[1] In addition to printing and publishing services it also offers online order fulfillment. The brand name is derived from the concept of a lulu as an old-fashioned term for a remarkable person, object, or idea. [2] The company's CEO is Red Hat co-founder Bob Young. Authors who publish/print materials and similar works through Lulu retain the copyrights to such materials and similar works. Optional services offered by the company include ISBN assignment, and distribution of books to retailers requesting specific titles (returns are not accepted, which limits distribution to physical bookstores). Electronic distribution is also available. Lulu Enterprises was founded in early 2002. OpenMind Publishing, founded by Bradley Schultz and Paul Elliot, merged its publishing company and staff with Lulu in the latter part of 2002. OpenMind Publishing was a publisher of customized texts for college professors. "
    },
    "authorBio" : {
      "backgroundColor" : "#808080",
      "textColor" : "#000000",
      "text" : "Jackson Rogers is is an internationally renowned author, reporter, and columnist - the recipient of two Pulitzer Prizes and the author of five bestselling books, among them Web Diagnostics and Social Media - From Applications to Zen Programming. He teaches at Harvard University."
    },
    "backCoverSynopsis" : {
      "backgroundColor" : "#C0C0C0",
      "textColor" : "#000000",
      "text" : "Making Money with iPad Applications belongs in the toolbox of every person interested in the design and development of  Web-based software, from the CEO to the programming team. Making Money with iPad Applications explores the building blocks of great Web applications and uses them as basic principles of design so that every project produces inspiring workflows with successful results.  Principles include creating  only whats necessary, getting users up to speed quickly, and preventing and handling errors. It offers practical advice about how to achieve the qualities of great Web-based applications and consistently and successfully reproduce them."
    },
    "reviewBlurbs" : {
      "backgroundColor" : "#808080",
      "textColor" : "#000000",
      "text" : "\"The perfect way to create extra income in these uncertain economic times\"
 - New York Times

 
\"Clear and concise, this guide is ideal for both beginners and those experts who know the code but need guidance with on and offline marketing .\"
 - Wired Magazine

 
\"There is a very obvious reason why Jackson Rogers is one of America's most celebrated Web authors: he is very good.\"
- CNET"
    },
    "publisherLogoFront" : {
      "image" : "http://cfl.uploads.mrx.ca/ham/images/newser/2009/08/BobYoung5725.jpg"
    },
    "publisherLogoBack" : {
      "image" : "http://cfl.uploads.mrx.ca/ham/images/newser/2009/08/BobYoung5725.jpg"
    },
    "backFlapImage" : {
      "image" : "http://cfl.uploads.mrx.ca/ham/images/newser/2009/08/BobYoung5725.jpg"
    },
    "authorPhoto" : {
      "image" : "http://cfl.uploads.mrx.ca/ham/images/newser/2009/08/BobYoung5725.jpg"
    },
    "spineTitle" : {
      "backgroundColor" : "#C0C0C0",
      "textColor" : "#000000",
      "text" : "Revenge of the Albatross\"quote\" and more stories"
    },
    "backCoverBarCode" : {
      "type" : "EAN",
      "code" : "9783468111242",
      "supplemental" : "54499"
    }
  },
  "backgrounds" : {
    "frontCover" : {
      "value" : "#996600",
      "type" : "ColorCode"
    },
    "backCover" : {
      "value" : "#996600",
      "type" : "ColorCode"
    },
    "spine" : null,
    "frontFlap" : {
      "value" : "#CCB399",
      "type" : "ColorCode"
    },
    "backFlap" : {
      "value" : "#CCB399",
      "type" : "ColorCode"
    }
  }
}
}

Fields

Description

There are three kinds of layout blocks: text, image, and barcode.  The supported fields are dictated by the layout block you are defining.  Please refer to our list of available layout blocks, their type, and the templates that include each block.

Features

Text for the text blocks can be marked up with supported html tags.  The tags must be passed as valid XHTML. 

The following tags are supported:

• line break (<br>)
• bold (<b>)
• emphasis (<em>)
• strong (<strong>)
• italic (<i>)
• ordered list (<ol> with <li>)
• unordered list (<ul> with <li>)
• underline (<u>)
• paragraph (<p>)

Limitations

• Fonts and font sizes are defined by the template, and cannot be changed through the API.
• Text overflows are not validated. The character limitations vary by text block and POD package, so the API user is required to check the generated PDF and ensure that all text that was supplied was rendered as desired before uploading via the Publication API.

Fields

Limitations

Fields

Fields

Description

Define a customizable background color or  background image for defined regions of the cover template. A background can be a valid HTML color code or an uploaded image file.

The various customizable backgrounds are: frontCover, backCover, frontFlap, backFlap, spine. If a background is not supplied, it will be assigned the default value.

Fields

Description

Describes the status of a cover conversion

Example

This is an example of a cover conversion status response.

{
    "conversionId": 12345,
    "status": "COMPLETED",
    "conversionStartDate": "2011-05-01T14:16:37.782-05:00",
    "conversionEndDate": "2011-05-01T14:17:10.124-05:00",
    "outputFileId": 51126
}
    

Fields

Description

The results of the cover size calculation for a given set of physical book properties.

Example

This is an JSON example of a response from the cover size calculation API call.

{
   "coverSizeData":    {
      "fullCoverDimension":       {
         "width":          {
            "valueInPoints": 646.22,
            "valueInInches": 8.98
         },
         "height":          {
            "valueInPoints": 513,
            "valueInInches": 7.12
         }
      },
      "spineWidth":       {
         "valueInPoints": 16.22,
         "valueInInches": 0.23
      },
      "spineIndentation":       {
         "length":          {
            "valueInPoints": 315,
            "valueInInches": 4.38
         },
         "orientation": "FROM_LEFT"
      }
   },
   "details": "",
   "status": 200
}

Description

A description of the physical book.

Example

This is the minimal data required to determine what the physical book dimensions will be.

{
  "numberOfPages" : 100,
  "color" : false,
  "trimSize" : "POCKET",
  "bindingType" : "perfect",
  "paperType" : "regular"
}
    

Fields