Apple News API

Use the Apple News API to publish and manage Apple News Format articles.

Overview

The Apple News API is a way for publishers to deliver their content to the Apple News app. Getting your content into Apple News involves two separate processes:

  • Create articles in Apple News Format. See Apple News Format.

  • Publish and manage your articles using the Apple News API.

To publish and manage your articles, including asset files, you have two options:

  • Use Apple News REST API. The Apple News API has typical RESTful characteristics and uses JSON for input and output.

  • Use Apple News API Client Utility. The Apple News API Client Utility is a Command Line utility (Ruby Gem). Download the file and follow the setup instructions provided in the README file. The README also includes a set of commands to perform operations that are supported by Apple News REST API. You can create, update, delete, and get details about an article and get basic information about your channel and sections.

Topics

First Steps

Setting Up Your News Channel

Understand the prerequisites for using the Apple News API.

Types of Fields Used in the Apple News API

Learn the standard field types used in the Apple News API.

About the News Security Model

Learn how the Apple News API authenticates clients, authorizes your news channel using an API key, and enforces confidentiality.

Channel

Read Channel Information

Get details about your channel, including name, corresponding website, and default section.

object Channel

See the fields returned by the read channel endpoint.

object ChannelLinks

See the links returned by the read channel endpoint.

object ChannelResponse

See which objects make up the channel response.

Sections

List All Sections

See a list of available sections in your channel.

Read Section Information

Get the specified section's name and channel, and learn whether it’s a default section.

Promote Articles in a Section

Set the list of promoted articles for the specified section.

object Section

See the fields returned by the section endpoints.

object SectionLinks

See the links returned by the section endpoints.

object SectionResponse

See which objects make up the section response.

object PromoteArticleRequest

See the required field for the promote article request.

object PromoteArticleResponse

See the field returned by the promote article response.

Articles

Create an Article

Publish a new article to your channel.

Read Article Information

Retrieve information about an article such as the revision number, maturity rating, and so on.

Search Articles in a Channel

See a list of all articles in a channel according to the specified search criteria.

Search Articles in a Section

See a list of all articles in a section according to the specified search criteria.

Update an Article

Update an existing article in your channel.

Delete an Article

Delete the specified article from your channel.

object Article

See the fields returned by the article endpoints.

object ArticleLinks

See the links returned by the article endpoints.

object ArticleResponse

See which objects make up the create article, read article, and update article responses.

object Meta

See the object that wraps the throttling information returned for the create article and read article endpoints.

object Throttling

See the object that wraps the throttling information returned for the create article and update article endpoints.

object Create Article Metadata Fields

See the optional metadata fields for the create article request.

object Update Article Metadata Fields

See the metadata fields for the update article request.

object SearchResponse

See the fields returned by the search article endpoints.

Errors

Error Messages

Understand the error message format.

object Warning

See the properties of a warning returned by the Apple News API.

object Error

See the properties of an error returned by the Apple News API.

type Code

See the error codes returned by the Apple News API.

type Status

See the HTTP status codes returned by the Apple News API.