Publishing API Specification
Overview
This API is REST based with JSON as the transport data type and defines the communication protocol between Skyword and a remote content management system (CMS). Skyword360 is the initiator for all of the API calls here. The Remote CMS is the receiver of those requests. It processes and responds back to Skyword.
This API specification is meant to be CMS agnostic. However, some CMSs may require some special functions or data elements depending upon capabilities.
API URL
As Skyword360 is the initiator (pusher) of the data transfer process, it is required that you implement and host a receiving HTTPS host listening. Skyword360 will invoke API methods that you have implemented in accordance with the API specification.
All endpoint methods that you implement must start with the path prefix of /skyword/v1/, for example:
https://some-server.com/skyword/v1/.
You will need to inform your Skyword Support or integration specialist with your URL. For testing purposes, you may want to configure a development or staging server and communicate that host to your Skyword Support representative.
Authentication
The newer version of the Skyword Publishing API specification no longer employs Oauth2. It uses an API key to secure all data transfers.
Contact your Skyword Integrations Team to receive your API key.
Pagination
Any GET calls that are paginated use the Link header introduced by RFC 5988. An extra header called X-Total-Count is sent with the total number of available results. For example:
GET https://some-server/skyword/v1/taxonomies?page=14&per_page=25
Link:
<https://some-server/skyword/v1/taxonomies?page=15&per_page=25>; rel="next",
<https://some-server/skyword/v1/taxonomies?page=34&per_page=25>; rel="last",
<https://some-server/skyword/v1/taxonomies?page=1&per_page=25>; rel="first",
<https://some-server/skyword/v1/taxonomies?page=13&per_page=25>; rel="prev"
X-TotalCount: 850
Full API Docs Specification
Complete documentation for all API methods can be found here:
Updated over 6 years ago