API Types Overview

FoxNose CMS provides two distinct APIs, each serving a specific purpose in managing and delivering your content: the Manage API and the Delivery API. These APIs work together to give you full control over your content management and content delivery workflow.

Manage API

The Manage API is the core interface for interacting with and configuring your project in FoxNose CMS. It enables you to control every aspect of your data, folder structures, and system settings.

Accessing the Manage API

The Manage API is accessed via a single, consistent URL regardless of your project or environment:

https://api.foxnose.net

This unified endpoint allows you to perform administrative tasks across all your projects and environments without the need for environment-specific URLs.

Key Features of the Manage API

Through the Manage API, you can:

• Configure Projects and Settings: Define project configurations, manage environments, and set up general project settings.
• Manage Folder Structures: Create, update, and organize folders, which are the core organizational units in FoxNose CMS. Each folder can hold documents or assets, either with flexible or structured data models.
• Define Data Schemas: Specify templates and schemas for documents stored within folders to ensure consistency or flexibility, depending on your needs.
• Control Access and Permissions: Set user roles, manage API keys, and define access levels for both teams and external clients.
• Upload, Update, and Delete Content: Add content to folders, update existing entries, and manage content lifecycle through deletion or archival.
• Set Up Webhooks: Automate workflows by configuring webhooks that trigger actions based on data changes, such as new content uploads or updates.

In essence, the Manage API is your administrative toolkit for managing your project’s structure, content, and permissions, laying the groundwork for delivering content efficiently.

Delivery API

The Delivery API is the interface through which your content is delivered to end users. Once you’ve organized your data using the Manage API, the Delivery API is automatically generated to reflect the structure and data created.

Accessing the Delivery API

Unlike the Manage API, the Delivery API’s access points are specific to each environment within a project. Each environment in a project has its own dedicated network address, identified by a unique key:

https://<ENVIRONMENT_KEY>.fxns.io

Additional subdomains are automatically generated for each environment to serve specific purposes:

CDN Subdomain

https://cdn.<ENVIRONMENT_KEY>.fxns.io

Storage Subdomain

https://storage.<ENVIRONMENT_KEY>.fxns.io

These subdomains are used for delivering content efficiently and handling asset storage separately from your main API endpoints.