Dive into the Quickstart Essentials for Sage Active Public API.
Get a practical overview with this brief, engaging video.
It showcases essential steps to kick-start your journey.
Perfect for beginners!
Quick start
Quick Links
Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoicesThis quick start guide explains how to:
- Access to your developer environment from Your Sage Active to begin exploring and testing the API.
- register your applications to obtain your keys needed to authenticate and use Sage Active Public API V2,
- run your first queries with Sage Active Public API V2 using Postman, the popular tool for testing APIs,
- discover the Hot Chocolate GraphQL syntax.
Follow the quick start steps 1 to 5 in order. Every step matters.
Start with the first step: Quick start / 1. Necessary prerequisites
Please note that the Sage Active Public API V2 is available for these Sage Active environnements.
During your API exploration, you should use the FR, ES, DE or PT production environment, depending on the subscription allocated to you.
Some benefits of a graphQL public API ?
The public API for Sage Active helps developers integrate accounting, sales, and operational data into their own applications for the French, Spanish, German, and Portuguese markets.
The highlights below summarize what makes Sage Active Public API V2 different from a classic REST integration.
10 highlights of the Sage Active Public API
- GraphQL-powered integration: Request only the fields you need in a single call. The strongly typed GraphQL schema makes integration efficient, flexible, and self-documenting.
- Secure by design: Authenticate with OAuth 2.0 using access tokens and
x-api-keyheaders. Build secure integrations for web, mobile, server-side, and machine-to-machine applications. - Complete business coverage: Access customers, suppliers, products, sales documents, purchases, stock, accounting, files, and more through one GraphQL endpoint.
- Built for European SMEs: Available across FR, ES, DE, and PT Sage Active environments, with legislation-specific rules built into the API resources.
- Advanced filtering, sorting, and pagination: Query large datasets efficiently using
whereoperators, ordering, and cursor-based pagination. - Built-in analytics: Retrieve aggregated totals, rankings, trends, and summaries through dedicated aggregation operations for reporting and dashboards.
- Queries, mutations, and business actions: Read and update data, then trigger business workflows (validate, post, close, and similar actions) from the same API.
- Related data in fewer round trips: Load headers, lines, and nested entities in one GraphQL request instead of chaining multiple REST calls.
- High-performance bulk access: Retrieve large volumes of business data with optimized queries and export-oriented capabilities.
- Backward-compatible evolution: New resources, fields, and capabilities are added continuously without breaking existing integrations.