Use your CMS with News Publisher
With Apple News Format you can create articles in your existing content management system (CMS) and then publish them directly to Apple News. You can connect your CMS to News Publisher using the Apple News API or a compatible plug-in, or work with an Apple News preferred provider to deliver your content to News Publisher. See Apple News Format for details on how to design and lay out articles in Apple News Format.
About the Apple News API
The Apple News API is a REST API for publishing Apple News Format articles to News. With the help of this API you can also retrieve, update, and delete published articles and get basic information about your channel and sections. For more information about Apple News API, see Apple News API.
To use the Apple News API, you need to be signed in to iCloud with an Apple Account that has two-factor authentication turned on. You also need the following information, which you can request by clicking Settings > Connect CMS in News Publisher:
Channel ID
API Key ID
API Key Secret: The secret is shown only when it’s first issued, but you can get the channel ID and API Key ID any time.
The Apple News API provides the following operations in News resources:
Read channel
List and Read section
Read, Create, Update, Promote, and Delete article
API requests vary depending on the type of operation. For example, to read a channel, you need only supply a channel ID (plus authentication information). To create an article, you need additional information, such as a complete Apple News Format document, various API request metadata, and parts that contain images and other resources.
When you publish an article via the API, the delivery time to the News app may vary depending on the complexity of the article and the number of images it contains. You don’t need to worry about caching or other common content delivery issues—Apple manages all content distribution and delivery.
The API uses an industry-standard authorization mechanism to protect your data and ensure that only approved clients have access to your content. You can download a command-line interface.
Connect your CMS to News Publisher
Sign in to icloud.com with an Apple Account that has two-factor authentication turned on, then click News Publisher.
Go to Settings > Connect CMS, then click the link to use the Apple News API or a plug-in to connect your CMS to News Publisher.
You can also work with an Apple News preferred provider.
Click Get an API Key, then write down the channel ID, key ID, and secret that appear in the dialog.
You can view your API Key ID and channel ID at any time by going to Settings > Connect CMS, but the secret appears only once. You need this information when using the API key with your CMS.
Note: If you lose the API key secret, go to Settings > Connect CMS, click the API Key link, then click Replace API Key. If you replace the key, remember to enter the information for the new key in your plug-in or code, as the old key is no longer valid.
Connect your CMS to News Publisher with the Apple News API or a plug-in, or work with an Apple News preferred provider to connect it.
Deliver articles from your CMS to News Publisher, then go to the Articles page to view them.
To see how your articles look in News, click
, then do any of the following:To preview on a Mac (with macOS 10.14 or later): Click View.
To preview on an iPhone or iPad: Click Copy on your Mac, then share the preview link (via email, AirDrop, or message, for example) to your iPhone or iPad with iOS 9, iPadOS 13, or later.
News launches, and the preview appears in the Drafts section.
Only articles uploaded as a bundle or delivered from your CMS can be previewed on a device.
Note: When working on your Mac, iPhone, or iPad, you must be signed in to the Apple Account you use for News Publisher in System Settings or Settings, and iCloud must be turned on for the News app and Passwords & Keychain.