API Documentation
  • Updated on 01 May 2018
  • 3 minutes to read
  • Contributors
  • Print
  • Share

API Documentation

  • Print
  • Share

The architecture of BizTalk360 has four main components -

  • Web interface layer
  • REST API Layer
  • BizTalk360 Monitoring Service
  • BizTalk360 Database

For more detailed information about each of these components, we recommend you to take a look at this article. The front-end web interface layer is a HTML5/JavaScript based Single Page Application (SPA). All communications between the web interface layer and the BizTalk environment take place through the REST API layer. The core of BizTalk360 capabilities are driven by the backend REST services that act as the bridge between the front end and the BizTalk environment.

There may be occasions when organizations face the need to show information from the BizTalk environment on external applications such as SharePoint, internal applications, internal dashboards, and so on. To achieve this, organizations are forced to write their own piece of code that will fetch the information from the BizTalk environment and display them in the external applications. This is definitely a time consuming task as it involves effort to write custom code and intensive testing to see if the code returns the exact intended result.

With API Documentation capability of BizTalk360, we have exposed over 350 REST services (APIs) that have the capability to retrieve the requested information from the BizTalk server environment. The APIs are defined as Swagger files which means that you have the ability to execute them inline to see if the result is what is intended. For example, you may want to display the list of BizTalk Applications or the performance of the BizTalk server (such as CPU, Memory, etc) in a custom dashboard application within your organization. With BizTalk360 API Documentation, it is very easy for you to consume the API and retrieve the information from the BizTalk server environment. It not only ends with these. You can access pretty much any information like EDI, BAM, Artifact information, and so on from the BizTalk environment with the help of BizTalk360 APIs.

Work with BizTalk360 Directly through the API Documentation

Another advantage of using the API Documentation capability within BizTalk360 is that you can still work with BizTalk360 through the API documentation section. If you are comfortable working with HTTP GET/POST requests, all it takes is to take the example JSON from the GET/POST API services and replace them with the appropriate values as in your environment.

Retrieve information about the BizTalk environment (using HTTP GET service) Let`s say, you want to retrieve the list of BizTalk applications in your environment with all the appropriate details. All you need to do is to navigate to the BizTalkGroupService (group services) and choose the Services.REST/BizTalkGroupService.svc/GetBizTalkApplicationsList from the list of APIs. All you need to retrieve the application information, is the "environment id" parameter. Copy the environment id from the Environment Details section on the BizTalk360 API's page and paste it in the "parameters" section of the HTTP GET service. In one click (Try it out! button), you will see all the details of the BizTalk applications in the selected environment. Similarly, you can retrieve the information of all the BizTalk applications across multiple BizTalk environments in the organization through the API documentation section of BizTalk360.

The API Documentation can be viewed from the Settings are in BizTalk360.

Modify information in the BizTalk environment or BizTalk360 database (using HTTP POST service) In addition to retrieving the information from the BizTalk environment, with BizTalk360 API documentation, administrators have the capability to modify the information in the BizTalk environment or the BizTalk360 database with the help of HTTP POST services. Let`s say, as a BizTalk360 administrator, you want to add a new user with Super User rights in BizTalk360. With the Services.REST/AdminService.svc/MaintainAdminUser service, you can easily add/modify a super user in BizTalk360. All you need to do is to copy the example JSON that is provided in the API documentation section and modify the values. In one click (Try it out!), you will see the response if the service call was successful or a failure. If the service call was successful, you will notice that a new user would have been added with Super User capabilities under User Access Policy section in BizTalk360.

Was this article helpful?