주 콘텐츠로 건너뛰기
Hints and Tips 생성 편집

Connection Issue

shutterstock_1550661830-20231117-013012.jpg

The Internet is essential to start MIDAS OPEN API because it was developed based on a Web-based API environment.

 

Troubleshooting Connectivity Issues Between CIVIL NX and Server

When encountering connectivity issues between the product and the server.

 

  • Check Server Status
    • Remove the port number and product-specific information from the baseURL.
    • Send a REST API request using the GET method.
    • Verify that the request status displays as 200.

image-20231024-021906.png

 

  • Check Local Network Connectivity.
    • Confirm stable connectivity within the network.
    • Review Company Firewall Policies. MIDAS Open API connects the external networks, and connection issues might arise due to firewall settings.
  • Retry after refreshing MAPI-Key.

If the connection still doesn't work despite these checks, please get in touch with MIDAS for more help.

 

Verifying Server Connection Before Requesting Multiple APIs

Before making numerous REST API requests, ensuring the product's connection to the server is established proves to be the best starting point.

 

Request

  • URL: Remove product information from BaseURL and append "/mapikey/verify."
  • HttpMethod: GET

 

Response

Upon receiving a response, the following details can be confirmed:

  • Status of Product Connectivity (status)
  • Validity of mapikey (keyVerified)
  • Logged-in User ID on the Product (user)
  • Product Information (program)
  • Volatile ID Identifying the Client (connectionID)
{
    "user": "User_ID",
    "program": "civil",
    "connectionID": "Connection_ID",
    "keyVerified": true,
    "status": "connected"
} 

image-20231025-070212.png

/mapikey/verify example

0
컨텐츠가 도움이 되셨나요?