Contents

Getting Ready to Publish and Manage Your Articles

Get set up for using the Apple News API.

Overview

Once you have created an Apple News Format article, you use the Apple News API to send a request to publish the article to the Apple News app. You can also send requests to manage the articles in your channel. For example, you can:

  • Update articles that have already been published

  • Promote articles in specific sections

  • See the sections available in a channel

  • Find a specific article

  • Delete articles that you no longer want in your channel

Verify Your Channel Security Information

Make sure you have the following security information, which you received when you set up your channel:

  • Channel name

  • Channel ID

  • API Key ID

  • API Key Secret

If you don’t have this information, see Use your CMS with News Publisher.

To learn how the Apple News API keeps your content secure, see About the Apple News Security Model. You’ll use the authentication steps as part of each request you make.

Get the Apple News API

Choose one of these options:

  • Download the Apple News API Client Utility (a Ruby Gem). Follow the setup instructions provided in the README file to install, configure, and use the utility.

  • Use the Apple News REST API. Write your own code to integrate the Apple News API with your content management system (CMS) in a way that’s compatible with your organization’s processes.

Send a Request for Each Task

Requests you send to the Apple News resource contain a method (GET, POST, PUT, or DELETE) and a URL with the required parameters. Requests also include all security information, headers, body, and other parts the endpoint requires.

For example, to publish an article, use the Create an Article endpoint that starts with the POST method and this URL:

POST https://news-api.apple.com/channels/{channelId}/articles

Validate Responses

The Apple News API returns the following responses:

  • An HTTP status code

  • A list of HTTP headers

  • A body that includes any error or warning codes

For a list of status codes, see Status; for an explanation of error codes, see Error.

See Also

Essentials