Midas Open API (Application Programming Interface)

Midas Open API(Application Programming Interface) Workflow

API(Application Programming Interface) is one of the ways to connect between computers or between computer programs. API helps interface within the software. There are often misunderstandings of why you want to implement an API. First of all, rather than focusing on the value of the API, it is better to think about the value of the effect it brings. APIs make sense when they provide a channel through which businesses can access the current value in new ways.

Open

This process is the first step toward design automation. The user designs a model, then transfers this model information through an API file format to midas Civil (Gen, CIM, or any other software that can receive the API data). The users can receive the structure analysis data with API format files and edit the result tables depending on project requirements. The users also can use their preferred text editing software such as Excel, Word, etc.

These convenience functions will help the civil engineers reduce the time and effort to design the same structures and utilize pre-designed models built with 3D modeling software(which offers API) with Midas structural analysis software. Significantly, post-processing, such as calling the result tables or taking analyzed result diagrams, will reduce repeating the work process and help make a better decision.

Open

For these reasons, worldwide clients are knocking on Midas API door.

How to use Midas Open API within different software

Even now, a lot of Civil engineers use semi-API, that is, *.mct file format. However, the Midas Civil *.mct file acts as a half-function API. The civil engineers make *.mct script based on their structures and import it into the midas Civil, and then structures are created and analyzed. Now, you could guess why I said a half function initially. If the API file wants to act as a completed function, it needs two things. The first one is the data, and the other one is the operator. The *.mct doesn't have an operator, so I called it semi-API.

Then, how to be a complete API? The answer is to add operators! Operators will call data from the MIDAS database. APIs connect Request data→ Find proper data → Response to the program.

There is a common language for using the API. The most commonly used formats are JSON and XML, and MIDAS IT chose JSON. The JSON format is applied to Midas CIM to interoperate with midas Civil. The CIM is a 3D modeling software for Civil Information Modeling, released overseas soon. CIM and Civil transfer each information through JSON. It is possible that users can edit JSON files directly, and software can import edited files.

Like the CIM and Civil interoperate method(transfer model information through JSON files), other 3D modeling software and midas Civil can transfer data for modeling and analysis. We will provide this interoperation for any Midas programs that can utilize it in the same way. The JSON format is readable for both humans and computers, and we are sure it won't be difficult for first-time users.

The users can utilize APIs as many as users want. Midas engineers also expect how users will broaden a range of applications of Midas API and apply our software with others for the AI design systems.

The role of user involvement in the success of the design project

Midas API opens the gate to transfer JSON data format for users to expand their availability. I'll explain the user involvement part within the whole API design procedure from this part.

This chart explains users' roles when using Open API. It looks complicated; however, traditionally, most of the processes have been conducted by structural engineers. We only added a Civil API process(convert data to JSON format). Midas Civil opens pre, and post-processing data and operators to connect users' 3D modelings and report forms. This process is just beginning for applying design automation systems.

Concluding

Midas API is open for users, and now, we endure to develop our API modules, not just a unit function, to make an effective work process. Beta test users' feedback and suggestions would be sincerely helpful in this evolution.

Why don’t we make a new intelligent design system with Midas API?