Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,110 of 9,110 pages
About the help in other languages
All help pages

The REST API for owners

What a site owner needs to know about the REST API of Exponential - what it serves, reads at v1 and v2 and writes at v2, how programs authenticate, why permissions still apply, who controls the credentials, and what to…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/customers/growth/rest-api-for-owners.md

On this page

The REST API for owners

This page is for owners whose site will feed an app, another website or an internal system. The REST API lets programs read content and, at version 2, create, update and delete it, as JSON over HTTP (REST API v1 and v2). You do not need to read the routes; you need to know what it means for control and safety.

Contents

  1. In short
  2. What stays in your control
  3. Which credential for which program
  4. Questions before going live
  5. Once a year

In short

From REST API v1 and v2:

  • One extension serves it: ezprestapi. The older ezprestapiprovider is deprecated; its final release is a compatibility shim on top of ezprestapi.
  • Reads answer at v1 and v2 (/api/ezp/v1/..., /api/ezp/v2/...); writes answer at v2 only.
  • Every read and write checks the user's policies (content/read, content/create, content/edit, content/remove), whatever the request was authenticated with.
  • Programs authenticate with an OAuth2 token or a personal API key sent as Authorization: Bearer expk_....

The business view is on REST API v1 and v2 for businesses.

What stays in your control

ControlHow
What a program may read or changethe policies of the account it acts as; a program never gets more than that account
Which content is publicthe same sections and roles as the website: content anonymous visitors may not read is not served to anonymous requests
Who may create keysthe policy apikey/create (Personal API keys)
What a key may doscopes chosen when it is made, never beyond the owner's policies
Ending accessrevoke the key; it takes effect at the next request on every server
Evidenceevery key made, revoked, first used or refused is in the audit trail as access.apikey.*

Tip

Give each integration its own account with a role that allows only what it needs, rather than a key on a person's account. When that person leaves, the integration keeps working, and you can see in the audit what the integration did.

Which credential for which program

From Apps and API keys:

ProgramCredential
An app whose users sign inOAuth2 (the users authorize the app)
A script or integration acting as one accounta personal API key with scopes
A script using the remote servicesa remote services token (Remote services (expservices))

Keys are shown once when they are made; only a hash is stored, so nobody can show a key again, not even an administrator (Personal API keys). Store them in the program's secret store, never in a document or e-mail.

Questions before going live

  • To do: Which account does the integration use, and what role does it have?
  • To do: Read only, or also writes? If it writes, is there an approval or a review of what it creates?
  • To do: Where is the key kept, who can see it, and when does it expire?
  • To do: What does the program do when the API answers with an error or the site is in maintenance?
  • To do: Who is told when the integration fails?
  • To do: Has the partner checked the version of ezprestapi and that the old provider extension is no longer active?

More questions are on Planning an integration.

Once a year

  • Administrators see every key at Setup > oAuth admin > API keys, with search and filters; revoke the ones nobody needs (Personal API keys).
  • Include the integration accounts in the access review.
  • Ask the partner whether an upgrade changes anything for API clients.

Become an Exponential Partner

Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x