How to call an API through POSTMAN tool and map with X3 fields Sage X3 Tips, Tricks and Components

Thông tin chi tiết

the variable HVAL(2)- Header variable of array index 2 to application/Json. Assign
the variable HCOD(2)- Header code of array index 2 to Content-type. Once you have OAuth2 authentication configured, you’ll want to add it to your web service calls. Build integrated software solutions with a flexible, intuitive, tailored business solution for your industry.

  • If your application/integration supports only a single country/region it would be good practice to pass the country param together with the value to ensure your users are correctly routed.
  • At present only a single Authorization Code Flow is available to the API’s.
  • Effortless cloud-based payroll solution for start-ups and small businesses.
  • This website is using a security service to protect itself from online attacks.
  • For example, the authorization request will fail if the user has a Spanish business and selects the US in the country/region selection screen.

After performing an import or export with the BATCH option, the status of the batch server job can be querried with this web service. In 1979 a French company called Société Parisienne de Micro-Informatique (SPEMI) was founded and they produced accounting software for Sord computers. The software was redeveloped for use on UNIX systems and a custom development tool was developed called Accès aux DONnées sous unIX (ADONIX).[4] Adonix Entreprise V2 was written on that platform. Advisors for technology.Save time and accelerate sustainable growth with our array of business management software and IT solutions. Because X3 does not allow basic authentication, it is necessary to use OAuth2 authentication for SOAP web services.

Recommended next steps

This post provide some .net examples of making REST requests to Sage X3, and parsing the data. The access token lasts only 5 minutes so, in case of token validity expiration, you should restart from step 4 in order to get new access token. The steps outlined here explain how to obtain the access token and how to use the refresh token to get a new access token if the current one has expired. This section explains how to use OAuth 2.0 to allow Sage Accounting users to authorize your app to access their data without sharing their actual login details. In addition to running in real time, web services can also be executed by our batch server. This can be useful when you need to process data at specific times during the day, or on a recurring basis.

sage x3 api

This website is using a security service to protect itself from online attacks. There are several actions that could trigger this block including submitting a certain word or phrase, a SQL command or malformed data. We come across the scenario, where we will use POSTMAN software tool  to examine the working of external API. REST services are available in sage x3 that returns data in a JSON format. In this blog, we are going to visualize the mapping of fields from postman to x3 Rest web services.

Sage Developer Community

We combine our expertise with accounting skills and systems experience, tailoring our services and solutions to satisfy your technology needs. Assign
the variable HVAL(1) -Header variable of array index 1 to username and password
separated with Colon. Choose
Post Method, A POST request is a method that is used when we need to
send some additional information inside the body of the request what is sage x9 to the server. Our SOAP Web Services enable you to develop a dynamic, seamless integration with other applications and data sources. Our REST based Data Integration API enables Developers to automate existing X3 File Import / Export infrastructure, by facilitating the secure transport of data files. Data Integration API is designed to work for multi-tenant X3 cloud configuration only.

The following resources and guides are meant to provide quick reference for developers to exchanging data with this type of configuration through the API Gateway. We recommend starting with our Quick Start Guide first to get you up and running in no time (OK, let’s say 5 minutes!). Web API calls are usually issued by programs but, as they are just HTTP requests they can also be tested interactively, directly in the browser, or better, with a tool like Postman. With Sage X3 Update 7 and later, REST services are now available to consume and interact with X3. In some cases, it may be necessary to modify the data types to match the possible values that may be returned.

Exchange the authorization code for the access token

This blog helps us to understand the mapping of fields from POSTMAN tool to X3 REST web services and code used to call an external API by using EXEC_REST_ES function by passing credentials in header variables. A simple to use, secure and highly functional service to build real-time responsive application integrations. If your application/integration supports only a single country/region it would be good practice to pass the country param together with the value to ensure your users are correctly routed. If you support more than one country/region but not all, consider providing your users with a UI country/region selector to allow the country value to be passed in the Authorization Request. Note – If the optional country param has not been passed in the Authorization Request the user will first be redirected to the country/region selection screen. Based on the selection, the request will then be routed to one of three Authorization servers located in UK, EU or NA.

sage x3 api

This flow requires the user of the Sage Business Cloud Accounting instance, to authenticate/grant access to the connecting application. To help you get started quickly with your application development, Sage provides sample applications that cover the basic GraphQL API calls to Sage X3 V12 on-premise only. More information about batch processing of imports and exports can be found in Batch Processing for Import/Export Templates, as well as our Online help center. These SOAP web services can be called from any program that can perform a SOAP web service in the correct format as described below. The applicative modules expose either a Web API (RESTful services) or more traditional SOAP web services that you can call from any language. The following function will obtain sales order details for a sales order transaction number.


Over the years, we have helped hundreds of small and medium sized businesses as their strategic business partner. We specialize in the needs of Entertainment, Software & SaaS, Professional Services, Manufacturing, and Non Profit organizations. Our experienced consultants have a passion for making every facet of your business successful and are intent on building a long-term relationship with every client. Once the class object is defined in .net, the REST object can be called and deserialized.

If you’re maintaining an app using an older version of the API, use the link below to access the documentation. The tool of choice for manufacturing and distribution businesses in the US. Sage Business Cloud Accounting and Payroll, formerly Sage One, is also a part of the wider Sage Business Cloud brand but aimed at smaller enterprises. Since 2001, RKL eSolutions has helped growing companies maximize their technology resources and investment.

Using OAuth2 to Make a Web Service Call

You revoke a refresh token so it is no longer valid for obtaining access tokens. Please note that you cannot revoke
access tokens, they are valid during their entire lifetime of five minutes. Once a refresh token is revoked, it cannot
be used to obtain a new set of access and refresh tokens, so that the user will need to authorize your app
again once the access token expires. You can use the refresh token to obtain a new access token if the current one has expired. This means that your users aren’t required to authorize your app every time you request a new token.

sage x3 api

This guide provides information to perform GraphQL queries on Sage X3 (on-premise only) with a third-party application. For authentication with Sage X3 Cloud, consult our GraphQL API Quick start guide. The first step is to create the Business Object(s) required to deserialize the results from the call.

Guide to Brexit changes in the Accounting API

We provide step-by-step instructions, from creating a provider to authenticating, using Google as an example. Features and functionality include support for common file formats, data translation and scheduled automation. When this endpoint is hit, the user is prompted to login to Sage Accounting and asked if they want to authorize your app. At present only a single Authorization Code Flow is available to the API’s.

Sản Phẩm Liên Quan