REST API – Kompletní dokumentace

Úvod do REST API

Plugin poskytuje REST API endpointy pro programové ovládání funkcí pluginu. API je založeno na WordPress REST API standardu.

Autentizace a oprávnění

Všechny endpointy vyžadují:

  • Autentizaci – musíte být přihlášený uživatel
  • Oprávnění – musíte mít manage_options capability (administrátor)

Autentizace pomocí nonce

// JavaScript
const nonce = wpApiSettings.nonce;

fetch('/wp-json/affinite-wp-watermark/v1/backup', {
    method: 'POST',
    headers: {
        'X-WP-Nonce': nonce,
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        offset: 0,
        limit: 10
    })
});

Autentizace pomocí Application Password

// cURL
curl -X POST https://example.com/wp-json/affinite-wp-watermark/v1/backup 
  -u username:application_password 
  -H "Content-Type: application/json" 
  -d '{"offset":0,"limit":10}'

Base URL a namespace

Všechny endpointy používají následující strukturu:

Base URL: /wp-json/affinite-wp-watermark/v1
Namespace: affinite-wp-watermark/v1

Seznam všech endpointů

  • POST /backup – vytvoření backupu obrázků
  • POST /apply-watermarks – aplikování vodoznaků
  • POST /apply-single/{id} – aplikování na jeden obrázek
  • POST /bulk-process-post – zpracování příspěvku
  • POST /restore – obnovení z backupu
  • GET /errors – získání error logů
  • DELETE /errors – vymazání error logů
  • POST /licenses/verify – ověření licence
  • GET /licenses/info – informace o licenci