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.
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 can offer many benefits for users in the French, Spanish, German and Portuguese markets.
Firstly, using a public API allows developers to easily integrate the features of Sage Active into their own software, making their software more powerful and user-friendly for end users.
Additionally, using GraphQL in the Sage Active public API can also provide significant benefits.
GraphQL is a query language that allows developers to request exactly the data they need, making the integration of Sage Active data more efficient and flexible.
For example, developers can use GraphQL to request only the data they need, instead of receiving all available data, which can save time and resources.
Finally, using GraphQL in the Sage Active public API can also improve the end user experience.
GraphQL allows developers to create smooth and intuitive user interfaces that can make using the software easier for end users.
Additionally, by using GraphQL, developers can create applications that are faster and more responsive, improving the end user experience.
10 highlights of the Sage Active Public API
- Single API for your entire business: Access customers, suppliers, products, sales documents, accounting data, files, and more through a single endpoint.
- Retrieve exactly the data you need: Select only the fields required by your application, reducing payload size and improving performance.
- Advanced filtering, sorting, and pagination: Query large datasets efficiently using powerful filtering operators, ordering, and pagination.
- Built-in analytics capabilities: Retrieve aggregated business information such as totals, rankings, trends, and summaries through generic operations designed for reporting and dashboard scenarios.
- Fewer API calls: Retrieve related business data in a single request instead of calling multiple REST endpoints.
- Safe and predictable evolution: New capabilities are continuously added while preserving backward compatibility for existing integrations.
- Data and business operations in a single API: In addition to querying and updating data, the API allows applications to execute business actions and workflows directly from the same endpoint.
- Consistent API across legislations: Develop once and access businesses in different legislations through a unified data model and API experience.
- High-performance bulk data access: Efficiently retrieve large volumes of business data with optimized queries and export capabilities.
- Designed for integration scenarios: Support both user-based authentication and machine-to-machine integrations for ISVs, partners, and enterprise applications.developers.