IMPORTANT: This documentation is a work in progress. Please keep checking for latest changes to remain updated.
Story
Story is a single self contained unit of data, describing a news item, along with its metadata like authors, sections, tags etc. Story should always be in the below format for the Quintype platform
Format
{"external-id":"external-id-4","headline":"Attractive headline","subheadline":"Attractive subheadline","slug":"slug","first-published-at":962582400000,"last-published-at":962582400000,"published-at":962582400000,"story-template":"text","temporary-hero-image-url":"http://domain.com/some-image.jpg","hero-image-metadata":{"width":980,"height":420},"hero-image-caption":"Attractive caption","hero-image-attribution":"Image attribute","status":"open,published","authors":[{"email":"foo@foo.com","name":"Foo Bar","username":"Foo Bar","external-id":"external-id-1"}],"sections":[{"external-id":"external-id-section-1","name":"Section Name","slug":"section-name","parent":{"external-id":"external-id-section-2","name":"Section Name","slug":"section-name","parent":{"...":"..."}}}],"tags":[{"external-id":"Tag id","name":"First Tag","slug":"tag1"},{"external-id":"Tag id","name":"First Tag","type":"type provided by support"}],"summary":"Suitable Summary.","body":"<p>Some Body</p>","story-elements":[{}],"cards":[{}],"seo":{"meta-description":"Some meta description","meta-title":"Some title","meta-keywords":["keyword1","keyword2"]},"metadata":{"key":"value"},"access":"","access-level-value":100,"alternative":{"home":{"default":{"headline":"Attractive alternative headline","hero-image":{"hero-image-url":"http://domain.com/some-image.jpg","hero-image-metadata":{"width":980,"height":420},"hero-image-caption":"Attractive alternate caption","hero-image-attribution":"Alternate image attribution","hero-image-s3-key":"publisher-name/import/path/to/folder/image.jpg"}}}}}
String (Upload images in QT’s aws S3 bucket, inside ‘import’ folder and place the s3 path here)
Notes
[1] All mandatory fields are marked with an *
[2] If you have more data in your current system, apart from the above representation, all those keys & values can be passed inside this metadata object. This data will only be available using the API, will not be shown anywhere in the Quintype user interface
[3] Slug should be alphanumeric string with hyphen as a delimiter of words. String should not begin or end with a hyphen. Characters should be in lowercase. Other special characters and consecutive hyphens are invalid.
Example
Slug
Validity
testslug01
✓
test1-01-slug
✓
test-Slug
✗
slug!test
✗
-slug-test-
✗
[4] Hero-image-metadata is mandatory if a hero-image is provided. It makes sure the image is rendered correctly on the page for different device screens.