Sage X3 GraphQL Connectivity General Discussion

In this section, you will build a simple application using Node.js which will perform GraphQL queries on the Sage X3 on-premise configuration. The SAFE X3 Web API is based on SData 2.0, a RESTful protocol specification published by Sage. The API reference lists all available endpoints of the Sage Accounting API. It is divided into different topics to make it easier for you to navigate through. Cloud-connected Business Management Solution for all businesses. The tool of choice for manufacturing and distribution businesses in the US.

In this tutorial I am using the latest version of X3, i.e. 2022 R1. Sage is adding new queries and integrations (also called mutations in GraphQL lingo) with every release, so it is worth being on the latest version. To see the latest additions to the GraphQL interface with every release, please refer to the Release Notes on public help centre. If you scroll down a bit, you will see a products category and there should be a Sage X3 specific product section.

API Reference

This test application uses parameters stored in a config.json file to generate the token. 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. After performing an import or export with the BATCH option, the status of the batch server job can be querried with this web service. 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.

Once you have OAuth2 authentication configured, you’ll want to add it to your web service calls. You can use REST web services with your Representation to Create records. Our SOAP Web Services enable you to develop a dynamic, seamless integration with other applications and data sources. Build integrated software solutions with a flexible, intuitive, tailored business solution for your industry. The Menu bar across the top has even more sections like Clubs, Calendar (for event scheduling), Dev Stream (live stream events), and Articles (what’s new and help topics).

Configuring TypeScript

Click on “Sage X3” to load X3 topics for General Discussion, Support specific Discussion, and Bug Reporting Discussion forums. There is plenty of more and each topic has the same layout and structure. The site is formatted to help all aspects of the development community from Beginners to advance users. 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.

• Clicking on the Blog Menu will take you to the Sage Developer Blog site.
• Assign
  the variable HCOD(2)- Header code of array index 2 to Content-type.
• There is plenty of more and each topic has the same layout and structure.
• Originally, in the beginning, the developer site mainly helped developers with XML/JSON calls for our Web server component.
• A query language and runtime for executing queries and modifying data, GraphQL is our technology of choice for building APIs, and enabling the development of Sage X3 integrated Apps.
• What if you wanted to take one of the sales orders, and return details?

Cloud accounting for small businesses, accountants and their clients. 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. Assign
the variable HCOD(2)- Header code of what is sage x3 system array index 2 to Content-type. Assign
the variable HVAL(1) -Header variable of array index 1 to username and password
separated with Colon. A query language and runtime for executing queries and modifying data, GraphQL is our technology of choice for building APIs, and enabling the development of Sage X3 integrated Apps.

Provider Services

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. These SOAP web services can be called from any program that can perform a SOAP web service in the correct format as described below. You can, for example, write in Java, PHP, JavaScript, .NET, C, etc. Cloud native business management solution for small and medium businesses.

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. Postman is a simple GUI for sending HTTP requests and viewing responses. REST services are available in sage x3 that returns data in a JSON format.

Sage X3 API

This post provide some .net examples of making REST requests to Sage X3, and parsing the data. As you may already know, starting Sage X R2 (V12), a new integration pathway has been introduced; the mighty GraphQL. In fact, X3's new ADC (Automated Data Collection) module uses GraphQL to integrate transactions and query data from X3. 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.

While there are lot to be learned and discussed, as promised I wanted to take this time and talk about how you can test REST web services with a simple representation we created previously. A simple to use, secure and highly functional service to build real-time responsive application integrations. 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.

Sage Developer Community

The calendar menu lists Sage specific events going on like summit or sessions or live streams. The Community Menu will take you to the online forum where you can chat with developers and educators from around the world, post helpful topics, ask / answer questions, get help, and more. Here you can find information about GraphQL, import/export, Web services, and other integrated APIs. The Developer site has several pages for a series of Sage products from X3 to CRM. Anyways, we are going to start with the X3 subsection under the Documentation menu. The application requires some external dependencies to manipulate the JSON web tokens and to make HTTP requests.

What if you wanted to take one of the sales orders, and return details? The following function will obtain sales order details for a sales order transaction number. We combine our expertise with accounting skills and systems experience, tailoring our services and solutions to satisfy your technology needs. 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 to the server.

Make your first API calls with Postman

Clicking on the Blog Menu will take you to the Sage Developer Blog site. You will find blog topics on anything like SwiftUI, JSON, TypeScript and more. Most Blogs are on topics like developer methodologies, tools, testing scenarios, or learning procedures that help make a better, more efficient developer (in general). This will go through the steps of getting started with GraphQL and Sage X3 integration and API usability.