API Overview

APIs let external systems communicate with your Instance. The API module gives you everything you need to build, secure, and manage custom integrations, from creating endpoints and writing authorization logic to managing GraphQL queries and browsing auto-generated API documentation.

Why Use the API Module

Modern products rarely live in isolation. Whether you need to sync data with a third-party platform, power a mobile app, or expose your Instance data to reporting tools, the API module is how you make it happen. Connect external systems, automate data flows between platforms, and secure access to your Instance data with fine-grained authorization logic. You can also manage GraphQL queries directly from the admin, giving you precise control over custom data operations without touching the codebase.

Use Cases

• Sync customer data between your CRM and external systems
• Build mobile app backends powered by your Instance data
• Automate order processing with e-commerce platforms
• Connect payment gateways and financial systems
• Expose data feeds for reporting dashboards and analytics tools

Key Features

• Custom API Endpoints - Define and manage the entry points through which external programs interact with your Instance. Support for GET, POST, PUT, PATCH, and DELETE methods.
• Authorization Policies - Control which requests can access your endpoints. Write custom security logic that validates every incoming request before it reaches your data.
• GraphQL - Create, edit, and manage GraphQL queries directly from the admin. GraphQL lets you request exactly the data you need, nothing more and nothing less.
• Insites API Documentation - Every Instance comes with built-in, auto-generated API documentation. Browse all available endpoints, view request and response formats, and test integrations right from your admin.

Getting Started

1. Start by browsing your Insites API Documentation to see the endpoints already available on your Instance and understand what is possible out of the box.
2. Create your first Custom API Endpoint to expose data or trigger logic through a URL of your choosing.
3. Secure it with an Authorization Policy to make sure only authorized requests get through.
4. Manage your GraphQL queries to build flexible, efficient data operations for your integrations.

Suggested first action: Head to Insites API Documentation to explore the endpoints already available on your Instance.

Learn More

• Insites API Documentation - Browse the auto-generated API docs built into every Instance. Explore available endpoints, view request and response formats, and understand how external systems can interact with your data.
• Custom API Endpoints Introduction - Learn how to define and manage your own API endpoints. Control which HTTP methods are supported and map URLs to the logic you want to expose.
• Authorization Policies Introduction - Understand how to write authorization logic that validates incoming requests before they reach your data. Your APIs deserve proper protection.
• GraphQL Introduction - Discover how to create and manage GraphQL queries directly from the admin for precise, flexible data operations.