Test your first query in Postman

1. Run Postman

2. Add the collection and the environment in Postman

1. Download the collection for Postman
   Download the Sage Active Public API collection for Postman

2. Depending on your Sage Active subscription environment, download the corresponding Postman environment.
   Download the Sage Active Public API FR environment for Postman
   Download the Sage Active Public API ES environment for Postman
   Download the Sage Active Public API DE environment for Postman

3. Import the Postman Collection

   1. Open Postman, go to Collections.
   2. Click on Import.
   3. Click on Choose Files.
   4. Select and open the first downloaded file: SageActivePublicAPIV2.postman_collection.json.

   

4. Repeat the same operation for the second file:

   1. Stay in the same place.
   2. Click again on Import.
   3. Click on Choose Files.
   4. Select and open the second downloaded file: SageActivePublicAPIFR/ES/DE.postman_environment.json.

   The collection Sage Active Public API is now available in Postman.

   As well as the environment Environment Sage Active Public API related to Your Sage Active.

   

   

3. Authentication configuration

Complete the list of variables

• Note that the Postman environment already has the following values set for :

  • Here are the different URLs for using the FR, ES, DE API and authenticating your application.
  • The URLs for the SBCAuth authentication service are the same for all three production environments.

  • In Postman environnement baseAddress = API Address without /graphql.

    Sage Active Prod FR

    API Address

    Sage Active Prod ES

    API Address

    Sage Active Prod DE

    API Address

    Authentication

    AuthUrl
    AccessTokenUrl
    Revoke Token URL prod

1. Click on Environment in Postman to see the environment named Environment Sage Active Public API.
   
2. Click Environment Sage Active Public API
3. Fill in CURRENT VALUE column following values that you will retrieve from the Solutions tab of your application :

4. Click Save

   Attention

   • In the context of this quickstart, for scopes, please choose :
     RDSA Read Sage Active Data and WDSA Write Sage Active Data to remain consistent with the rest of the journey and the read and write permissions you just granted in your application.
   • If you are using Postman Web, the callback URL is automatically defined by Postman and may vary depending on the environment or configuration.
     You should copy the callback URL displayed in your Postman instance and add it in the Solutions tab of your application.
     In this case, you do not need to provide the callBackUrl variable.
     If the callback URL in Postman matches the example below, you can reuse this value.

   • In callBackUrl VARIABLE (Postman for windows only), the first Callback URL that you have filled,
   • in clientId VARIABLE, the Client ID,
   • in clientSecret VARIABLE, the Client Secret,

   • in scopes VARIABLE, the Permissions :

     • RDSA if you have chosen Read Sage Active Data
     • WDSA as well if you have chosen Write Sage Active Data
   • in subscriptionKey VARIABLE, the Subscription Primary key.

   Remember, get the values from the Solutions tab of your application:

   

   

4. Ask a New Access Token

Authentication checking

You will now be prompted to login to your application.

• The window for connecting to your application appears.
  Enter the email and password of your Sage Active account and validate.

• Now you need to give your app permission to access your Sage Active data

5. Use Token

6. Choose an organization and request the list of Journals

For our example we are going to request :

• the list of authorized organizations for the current user to retrieve the id of an organization.
• then the list of journals in this organization.

Request the list of organizations

Request the list of journals

   query {
   journalTypes (
         where:{ type:{in: [PURCHASE_INVOICE, SALES_INVOICE]}}
   ) {
         edges {

7. Recommendations

Testing Queries with an Organization Containing Demo Data Already

To maintain consistency, take account of current FR, ES, or DE legislation, and optimize data additions, we recommend you test queries wit an organization that already contains demo data.

How to import Demo Data?

Import demo data

All Videos

Discover how then sample quotes app now seamlessly enables the importation of a comprehensive set of demo data into your current company, should it find the data vaults empty.

A simple, streamlined process to kickstart your experience with fully populated data!

How to import Demo Data in your organization ?

Importing a demo dataset through the Samples quotes app, provided as an API usage example, is straightforward.

Follow these steps:

1. Launch the Online version of the sample quotes. Sample quotes / 2. Test the app Online
2. Select the organization where you wish to import the demo data.
3. If this organization does not yet contain demo date, a dialog box will appear, offering to import the demo data.
   The app detects automatically if you already have demo data and automatically adjusts the import dialog box to either import all demo data or only the new data that was not available in previous versions of the import tool.

The imported data pertains to:

• Customers: A batch of customers from the legislation, customers in France, one customer per VIES country
• Suppliers: A batch of suppliers from the legislation, suppliers in France
• Employees: A list of employees with names in line with the legislation
• Products: A list of products with titles and descriptions in the language of the legislation
• Fiscal years: Two calendar years, n-1 and n
• Accounting entries: A set of accounting entries consistent with the legislation
• Sales Quotes: A list of sales quotes relevant to the demo data
• Orders: A list of orders associated with the demo organization
• Delivery Notes: A set of delivery notes related to demo orders
• Sales Invoices: A collection of sales invoices based on demo data

• In each legislation, a customer and a supplier have been chosen to assist with demonstrations; they have a larger number of accounting entries than other third parties.
  • customer: CARAT - Carat S.a.r.l
  • supplier: BILLOT - Billot

  • customer: 8008 - José Martínez Pérez
  • supplier: 1005 - Carmines Juanan

  • customer: 10135 - Krause Bürotechnik GmbH
  • supplier: 70028 - Manderscheid Gmbh

  • customer: (PT demo third party — to be confirmed)
  • supplier: (PT demo third party — to be confirmed)
• To always stay in the same context of demonstration, each month contains the same accounting entries, so no matter the day of the demonstration, the journal entries will always present the same information.

Pre-request Script and Test tabs

8. Well done !