Publishing API Data Flow

The Skyword Publishing API delivery method supports a number of data requests for publishing content out of Skyword360 and syncing lists between Skyword360 and your CMS. The API specification for client-side plugins determines what data can be transmitted between the Skyword360 and a CMS and how data is returned.

Publishing Process

Publishing content from Skyword to your CMS will typically result in multiple API calls to be made from Skyword to your CMS/listener. Typical data flow calls initiated would include:

1. Skyword will try to verify that the author for the content exists.
2. If the author does not exist, Skyword will attempt to create the author in your CMS.
3. If the content contains embedded images or files, Skyword will first attempt to transmit those binary files to your CMS.
4. For each image created, transmit metadata related to the image such as title, description, etc.
5. Skyword will then attempt to transmit the final version of content which may contain references to the previously created author and images.
6. Skyword will finally attempt to retrieve details (the final URL) of the post just created

The following low-level API methods are used in this order.

1. GET https://your-server/skyword/v1/authors{id}
2. POST https://your-server/skyword/v1/authors
3. POST https://your-server/skyword/v1/images
4. POST https://your-server/skyword/v1/images/metadata
5. POST https://your-server/skyword/v1/posts
6. GET https://your-server/skyword/v1/posts/{id}

Authors

When content authors get created in the Skyword360 channel that do not already exist in your CMS, the API offers a POST /authors call to transfer the information and create a new user in the CMS.

With this call, you do not have to invite new users to your CMS and grant them access—the Skyword API creates the accounts automatically.

See authors for specifications.

Image Transfers

Content created in the Skyword Platform may contain one or more image attachments. These elements are transmitted separately from the data in the content template fields. Each POST /images call creates a new file containing the image in your CMS. The response to this call is a link header with the API URL for the media object. The Skyword Platform stores the URL as part of the attachment record in order to display it on user demand and track it with its content.

See images for specifications.

Image Metadata Appends

The meta info that accompanies an image attachment must be added to the CMS file created by the images transfer. This call adds the image title and image ALT tag to the file.

See Add metadata information for specifications.

Content Transfers

Approved content items that emerge from a Skyword360 channel's workflow get transmitted to your CMS for any remaining adjustments and publishing. The content POST call creates a post in the CMS. The data transmission includes template fields and values, Skyword internal content ID, content type, title, author ID, and settings for appending the Skyword Tracking Tag.

See posts for specifications.

Get Post Info

After posting content to your CMS, the Skyword Platform requests the ID and URL of the new post. The response returns the post content, published URL, and CMS post ID, all in JSON format. This exchange serves as a test that the Skyword API can access the post. The Platform stores this information for future access needs, such as republishing for content updates.

See Get a list of posts for specifications.

Taxonomy and Author Sync Process

Taxonomy Sync: Taxonomies are lists of items that populate drop-down menus in a Skyword360 channel's content templates. Skyword Publishing API provides a method to keep the Skyword360 channel in sync with your CMS by pulling new lists and values with the GET /taxonomies call. Each call returns 250 values. If a list has more than 250 terms, the call can be repeated until all terms are transmitted. If a list or terms in a list do not already exist in the channel, they are automatically created.

See taxonomies for specifications.

Author Sync: Like taxonomies, a CMS can store a list of content authors. By keeping the Skyword channel's author list updated, users can select approved authors from a list appearing in the content template. This call returns the first name, last name, email, and byline of each author.

See Retrieve a list of authors for specifications.