Production Environments

• How to find ?
• For each environment, you will find the role, API domain, and main URLs for authentication using the SBCAuth service.
• For the development, testing, and production phases of your application, you should use Your Sage Active

Legislation

• How to find?
• Sage Active is compatible with legislation for FR, ES, or DE.
• The current legislation is derived from the current organization via the legislationCode field of organizations.
• Depending on the legislation, different business rules may apply.
  The tabs below will allow you to choose a legislation and see the specific rules that apply to that legislation on all pages.
  At any time when you see these tabs, you will be able to change the legislation.
  Here you will see elements specific to the FR legislation.

  Here you will see elements specific to the ES legislation.

  Here you will see elements specific to the DE legislation.

  Here you will see elements specific to the PT legislation.

Tenant DEPRECATEDThis object is now deprecated, and we recommend using an alternative solution

• The unique identifier for a specific tenant, representing the technical storage space for one or more organizations. A Sage Active user may have access rights to organizations that are located across multiple tenants.

• UPDATEDModifications have been made to the properties or attributes of this object recently. the tenantId is no longer required in the request headers and is no longer used by the API.
  All tenant resolution logic has been removed from request processing.

  • For backward compatibility, providing the tenantId in the header is still accepted, but it is completely ignored and does not participate in any authorization, routing, or data resolution.

  • As a result, when reviewing or maintaining code that uses the API, it is recommended to remove the tenantId from request headers to simplify integrations and avoid keeping unused technical concepts.

  • When querying organizations, it is no longer necessary to retrieve the tenantId.
    Only the organizationId is now required to interact with the API.

  Important note regarding the following operations:

  • countries,
  • zipCodes,
  • currencies,
  • documentTypes

  Previously, these operations did not require the X-OrganizationId header, because the X-TenantId header was used to resolve the current legislation.
  This legislation was necessary to return the correct values for these operations.

  Since the X-TenantId header can now been removed, it is mandatory to provide the X-OrganizationId header in order to continue resolving the applicable legislation and retrieve the correct values for these resources.

Organization

• How to find?
• The unique identifier for a specific organization within a tenant, allowing for individualized management and customization.
• An organization is also called company in the product interface.
• Except for resources common to all organizations, it is necessary to include in the header the X-OrganizationId, which corresponds to the organization’s Id.

SubscriptionKey / x-api-key

• How to find?
• The x-api-key is a specific header used in HTTP requests to authenticate an application accessing an API.
  It verifies the application’s subscription to the API, enabling management of usage and access control.
• You can retrieve your primary or secondary subscription key linked to your application from your developer space.
• Always include a x-api-key in the header.

Authentication

• How to find?
• Sage Active Public API V2 is secured by Oauth 2.0.
• You will find explanations on how to implement authentication for web, mobile, or desktop applications within Sage Active Public API V2.

Mutation

• In GraphQL, a mutation is an operation that changes data on the server.
• It’s similar to the concept of HTTP POST (for creating), PUT PATCH (for updating), and DELETE (for removing) requests in RESTful APIs.
• Mutations are used when you want to create, update, or delete data and always use the POSTmethod.

Query

• On the other hand, a query is an operation used to retrieve data from the server.
• It’s analogous to an HTTP GET request in RESTful APIs.
• But in GraphQL, the queries use always the HTTP POSTmethod.
• Queries are used when you want to read or fetch data from the server.

Post

• Unlike RESTful APIs, there are no GET PUT PATCH DELETE methods utilized.
• In GraphQL both mutations and queries are defined in your GraphQL schema and are executed using the same mechanism.
  The key difference lies in their intended purpose: mutations for data changes and queries for data retrieval.
• Whether dealing with mutations or queries, the HTTP POST method is exclusively used.
  This uniformity simplifies the request handling and aligns with the GraphQL standard practices.