Skip to main content

Search

Type a word or a question to search the help articles.

How do I let another app read my stories with an API key?

In this story

Where: Settings → Advanced → Connect other apps

Open this page: admin.<your-site>/settings/integrations (replace <your-site> with your site address). If you don’t see it in the menu, turn on Show all settings on the Settings page.

Before you start

  • You are the site owner. Only the owner can manage keys.

Steps

  1. Open Settings → Site & brand → Add features. The page is called Features.
  2. Find Partner API and API keys. If it shows Off, turn on Use this feature.
  3. If it says Not in your plan, see your plan on keynate.com (Choose a plan).
  4. Open Settings → Advanced → Connect other apps → API keys.
  5. Tap Create key. Give it a name and choose what it can do.
  6. Optionally set an expiry date, allowed addresses and request limits.
  7. Copy the key when it is shown. You see it only once.
  8. Give the key to the other app. It sends it in the Authorization header as a Bearer key.

Good to know

  • Limits are per minute (1 to 600) and per day (1 to 1,000,000). An app that asks too often gets a "try again later" answer.
  • You can list up to 20 allowed addresses.
  • New key replaces a key. You choose how long the old one keeps working.
  • Each key shows its use in the last 30 days.
  • To stop using it, turn Use this feature off. Your site and admin then stop showing it, and you can turn it on again any time.

Common problems

I reached the number of keys I can have. Why: There is a limit on keys. Fix: Stop a key you no longer use first. The admin says "You have reached the number of keys you can have."

I cannot find Partner API and API keys in my admin. Why: The feature is off or not yet installed. Fix: Open Add features in Settings. The admin says: "This feature is switched off. The owner can switch it on in Features." Ask the owner to switch it on, or buy it if it says Not in your plan.

Questions

Frequently asked questions

What can a key do?

You choose: read stories, read full paywalled text, send drafts, send photos, read sections and tags, read traffic numbers or read money reports. Paywalled text needs its own permission.

Can an app publish stories?

No. Apps can add drafts. Nothing goes live without your team.

What if a key leaks?

Make a new key and choose Stop now so the old key stops working at once.

Feedback

Was this helpful?

Also available in

Still need help?