Find here all the main useful information.

• Best Practices

  A summary of good practices to apply for the use in your applications of Sage Active Public API V1.

• Environments

  A summary of Available Environment URLs and Their Differences.

• API: Authenticate

  Sage Active Public API V1 is secured by Oauth 2.0 authentication.
  Follow the suggested steps to implement authentication in your application.

• User consents

  Each user of an application using the API must explicitly give their consent to grant the application the right to access their data.

• Operators & keywords for queries

  Referencing of the different operators and keywords that can be used for your Sage Active Public API V1 queries.

• Understanding DTOs

  When working with GraphQL, specifically Hot Chocolate, in the context of Sage Active Public API V1, it’s essential to understand the role and naming convention of Data Transfer Objects (DTOs).
  These DTOs facilitate data exchange between client and server and play a critical role in mutations and queries.

• API: Pagination

  The notion of pagination is fundamental, it is important to know that Sage Active Public API V1 returns a maximum of records for each request.

• API: Updating records

  In GraphQL, particularly with Hot Chocolate, updating records involves a precise and efficient approach. Let’s explore how modifications and deletions of sub-resources are achieved using the requestedAction field..

• GraphQL Complexity Limit

  GraphQL queries offer flexibility and customization to users, allowing them to define their own queries.
  However, this advantage can also be a potential drawback, as users may execute queries that consume significant resources.
  To prevent overloading the GraphQL engine with excessively complex and resource-intensive queries, a complexity limit is enforced on the public GraphQL API

• Filtered By Id instead of ById

  The shift from specific

• Users management

  User management enables the definition of users, their roles, and their access to businesses (known as organizations in the API context).
  The public API considers these roles to authorize or deny access to data based on the current user’s roles.

• Benefits of DataLoaders COMING SOON This feature is currently in development and will be available in the next version. It’s already documented to keep you informed about its upcoming availability

  GraphQL Hot Chocolate DataLoaders offer a powerful solution for efficiently fetching data in GraphQL applications.
  By leveraging DataLoaders, developers can significantly reduce the number of database calls, thus minimizing the response time and improving the overall performance of the API.