REST API - Overview

AffiliateWP 1.9 introduced a slew of read-only REST endpoints that build upon the infrastructure included with WordPress 4.4 and later.

In order to leverage core REST endpoints, all API consumers must authenticate using API keys generated from a new API Keys tab located at Affiliates → Tools → API Keys.

See the REST API Authentication article for more information on generating and managing API keys.

Routes and Endpoints

Out of the box, AffiliateWP 1.9+ offers five routes and multiple underlying endpoints. Those five routes are:

  1. affiliates
  2. creatives
  3. payouts
  4. referrals
  5. visits

Click the route names above to find out more about their respective endpoints, see example requests, and more.

Note: complete Create, Read, Update, and Delete (CRUD) operations can be enabled through the REST API Extended add-on. See the REST API Extended documentation for information on Create, Update, and Delete operations.