Developer overview

This section is the developer entry point for building with APIEase as code.

For most teams, the recommended path starts with apiease-template, uses apiease-cli for day-to-day operations, and reaches for the APIEase Public API only when direct HTTP automation is the better fit.

If you are new to this workflow, start with Quickstart with apiease-template.

Choose an interface

Choose the interface based on where you want the work and its review history to live:

Interface	Best fit
APIEase admin	Create, edit, test, and run resources interactively.
Apex in APIEase	Ask the in-product assistant to create, update, or delete requests and widgets during a conversation.
apiease-template	Establish a repository layout for source-controlled requests, widgets, variables, and functions.
apiease-cli	Initialize or upgrade a template project and sync its saved resource definitions with APIEase.
APIEase public API	Build custom HTTP automation for saved resources or execute an existing saved request remotely.
Coding agent in a template repository	Edit version-controlled resource definitions, review them in git, and optionally sync them through apiease-cli.

These are separate workflows. Apex changes APIEase resources directly during the conversation. A coding agent working in an apiease-template repository changes local files first, so the git diff can be the review boundary. See Using APIEase with AI agents for the safety and resource-scope distinctions.

Recommended path

Use this reading order when you are getting started:

1. Why use the template to understand why apiease-template is the recommended starting point
2. Quickstart with apiease-template to initialize the project, configure auth, and sync resources
3. Resource handles to understand stable identifiers for source-controlled resources
4. apiease-template to understand the repository layout and what belongs in source control
5. apiease-cli for the command-line workflow that manages saved resources
6. APIEase Public API when you need lower-level HTTP integration
7. Using APIEase with AI agents when Codex-style agents will work inside the repository

Choose the right page

Use these pages based on the job you need to do:

• Quickstart with apiease-template: the canonical start-here path for repository-based APIEase development
• Why use the template: why the template comes before the CLI or public API in most projects
• Resource handles: stable public identifiers for requests, widgets, variables, and functions
• apiease-template: expected repository layout, template-managed files, and version-controlled artifacts
• apiease-cli: installation, configuration, CRUD commands, and template upgrade workflow
• APIEase Public API: authentication, resource routes, remote request execution, and direct HTTP usage
• Using APIEase with AI agents: repository-first guidance for Codex-style agents
• Developer and automation FAQ: concise answers about public API access, handles, remote execution, source control, the CLI, and AI-assisted workflows

How this fits the rest of the docs

The Developers section focuses on the developer workflow around repositories, the CLI, and the public API.

For request behavior, request contracts, and other platform concepts, use the existing docs instead of treating this section as a duplicate reference:

• Requests Overview
• Request Types Overview
• Request Parameters Overview
• Triggers Overview
• Widgets Overview
• Functions
• Variables

Practical workflow summary

In the intended workflow, you initialize a repository from the template, keep resource definitions in git, use apiease-cli to sync them with APIEase, and use the public API directly only when you need lower-level automation outside the normal CLI path.