API

The Ezoic API lets your server call Ezoic services directly over HTTPS, authenticated with a single API key. Turn on the services you want from the API Access page in your dashboard, then call them through the Ezoic API gateway.

Services

Service What it does
Big Data Analytics Pull predefined and custom reports and their data.
CDN Clear and purge cached content.
Subscriptions Verify reader access and read subscriptions server-side.

Looking for an API service you don't see listed here? Contact your account rep — we can enable additional services by request.

Enable API Access

Each service is off until you turn it on:

  1. In your Ezoic dashboard, open Settings → API Access.
  2. Turn on the service you want to call.
  3. Copy your API key from the API Access page.

Your API key is your Ezoic API-gateway developerKey. It is shared across every Ezoic API service you enable, and you can regenerate it from the API Access page.

Turning a service on or off only controls whether your key can call it. It never changes how your site runs or what your visitors see.

Base URL

All requests go through the Ezoic API gateway:

https://api-gateway.ezoic.com

Authentication

Every request carries your API key as the developerKey query parameter:

?developerKey=YOUR_API_KEY

The gateway authenticates the key and confirms it is enabled for the service, and that any domain you pass belongs to your account, before the request reaches the service. A key can only ever act on its own domains.