Back to Main Site

PolyCMS API Explorer: Interactive REST Sandbox for RISE CRM

Last updated on Nov 22, 2026 7:37 AM 7:37 AM 1,873.47 ms

API Explorer is a bundled PolyCMS developer plugin that gives you an interactive REST API sandbox directly inside your RISE CRM admin panel. Without installing external clients like Postman or Insomnia, you can test live GET, POST, PUT, and DELETE requests across Posts, Pages, Categories, Tags, and database-backed Media while copying ready-to-run code samples in cURL, PHP, JavaScript, and Python.

Prerequisites and Access

Before executing requests in the sandbox, verify that both the plugin and the REST API service are enabled:

  1. Navigate to PolyCMS > Plugins and ensure API Explorer is activated.
  2. Open PolyCMS > Settings and switch to the REST API tab (#tab-api).
  3. Toggle Enable REST API on and confirm a valid API key (pcms_...) has been generated.
  4. Click PolyCMS > API Explorer (/polycms/api-explorer) in the left sidebar.
  5. Select a resource tab (Posts, Pages, Categories, Tags, or Media), choose an HTTP method, and click Send.

Staff users require either RISE Administrator access or the polycms_view role permission (configured under Settings > Access Permission > Roles) to open API Explorer.

Supported REST Resources

API Explorer connects to all PolyCMS REST API v1 endpoints under /cms/api/v1/:

Resource Endpoint GET POST PUT DELETE Notes
Posts /cms/api/v1/posts Yes Yes Yes Yes Full CRUD with status, taxonomy, and featured image support
Pages /cms/api/v1/pages Yes Yes Yes Yes Full CRUD for static CMS pages and templates
Categories /cms/api/v1/categories Yes Yes Yes Yes Full CRUD including hierarchical parent relationships
Tags /cms/api/v1/tags Yes Yes Yes Yes Full CRUD for tag taxonomy management
Media /cms/api/v1/media Yes Yes No Yes Database-backed (blog_media), paginated listing, multipart upload, cascade delete

Key Sandbox Features

One-Click Live CRUD Testing

API Explorer pre-populates valid JSON request payloads with timestamped sample values so you can test write operations immediately without hand-writing JSON bodies. After any successful POST, PUT, or DELETE call, the resource list reloads automatically to reflect the live database state.

Smart PUT Update Testing

When testing PUT requests, API Explorer reads the selected record's existing title and appends a timestamp suffix. This lets you confirm update mutations cleanly while avoiding accidental duplicate slugs or confusing overwrite tests.

Visual Data Table and Raw JSON Inspector

Responses render both as raw formatted JSON and as a structured, sortable data table featuring status badges (Published, Draft), clickable frontend preview links, and detail modals for inspecting full record metadata.

Multi-Language Code Samples

Switch tabs in the code generator panel to copy ready-to-paste client snippets pre-filled with your RISE CRM site URL and active X-PolyCMS-API-Key header in four languages:

  • cURL (CLI and shell scripts)
  • PHP (curl / backend integrations)
  • JavaScript (Browser or Node.js fetch API)
  • Python (requests library)
# Example cURL snippet generated by API Explorer
curl -X GET \
  -H "X-PolyCMS-API-Key: pcms_your_api_key_here" \
  -H "Accept: application/json" \
  "https://your-rise-crm.com/cms/api/v1/posts"

Media Resource Testing (blog_media)

The Media tab interacts directly with the database-backed blog_media table and your files/polycms/ storage directory:

  1. List Media (GET /cms/api/v1/media): Browse uploaded files with pagination, filename search, MIME type filtering, file sizes, and image dimensions.
  2. Upload Media (POST /cms/api/v1/media): Upload files using the built-in multipart/form-data form. Successful responses return the new media_id so you can immediately pass it as feature_image_id when creating a post or page.
  3. Delete Media (DELETE /cms/api/v1/media): Removes the physical file and thumbnails from files/polycms/, deletes the record from blog_media, and clears dangling feature_image / feature_image_id references on posts and pages.

Security and Pipeline Parity

Requests sent from API Explorer authenticate using your configured X-PolyCMS-API-Key header and pass through the exact same stateless REST API pipeline as external clients:

  • CSRF Exclusion: PolyCMS registers cms/api/v1.*+ via RISE CRM's app_filter_app_csrf_exclude_uris filter so stateless API clients work seamlessly without session cookies.
  • Rate Limiting: Enforces your configured per-minute read and write limits via Polycms_Rate_Limiter (writable/polycms/rate_limit/).
  • Input Sanitization: Runs rich-text payloads through the plugin-local HTMLPurifier (vendor/ezyang/htmlpurifier) and enforces full upload security validation on media files.

Who Should Use API Explorer

  • Headless Frontend Developers connecting React, Vue, Next.js, or Nuxt storefronts to RISE CRM content.
  • Mobile and Integration Engineers syncing articles, changelogs, or media assets with external apps and automation tools.
  • PolyCMS Plugin and Theme Developers verifying payload schemas and API permissions during development and QA.

Related Documentation