API Overview

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

Management API

API Reference: Management API

The Management API is the core interface for interacting with and configuring your project in FoxNose. It serves as your administrative toolkit for managing your project's structure, content, and permissions.

Endpoint

The Management API is accessed via a single URL:

https://api.foxnose.net

Key Capabilities

Through the Management API, you can:

• Environment Management: Create and manage environments within your projects
• Folder Organization: Create, update, and organize folders - the core organizational units in FoxNose that can hold resources with flexible or structured data models
• Schema Definition: Specify components and schemas for resources stored within folders to ensure consistency or flexibility, depending on your needs
• Access Control: Set user roles, manage API keys, and define access levels across your organization
• Resource Management: Add resources to folders, update existing entries, and manage the complete resource lifecycle

Flux API

API Reference: Flux API

The Flux API is the interface through which your content is delivered to end users. You can create multiple APIs within the same environment using the Management API, each serving different purposes or audiences. For each Flux API, you can individually configure which data and folders are accessible.

Endpoint Structure

Unlike the Management API, Flux API access points are specific to each environment within a project. Each environment has its own dedicated network address, identified by a unique key:

https://<ENVIRONMENT_KEY>.fxns.io

Key Capabilities

The Flux API excels in two main areas:

Advanced Search and Filtering

• Sophisticated Query Capabilities: Logical operators (AND, OR, NOT), locale-specific filtering, full-text search, and vector search
• Multi-Method Search: Combine multiple search methods and perform joins across related documents
• Intuitive Query Syntax: Supports multi-level relationships through an easy-to-use query language

Flexible Content Retrieval

• Granular Control: Retrieve complete resources or specific locales with precise control over the response payload
• Deep Population: Supports deep population of related documents across multiple nesting levels
• Single-Request Efficiency: Fetch comprehensive content structures in a single API call