/
Verify Web Server URLs

Verify Web Server URLs

Search the IFS Energy & Resources Connect Wiki
 

Back to Configuring IFS Connector     Back to Manually Test Your Connection



Since IFS Connector uses multiple web services, you will need to request data from at least one service to see if the Connector is working, using the GET method.    

Use this step to find the exact URLs you need to use before starting the request process in Postman.

Request URL Format: http://SystemServiceUri/ApiPath  

The Request URL must be set to the SystemServiceUri concatenated with the ApiPath as set in the IFS Connector Database tables P2System and Request tables.

Note: The examples on this page use fictional URLs for a fictional company called C6 Pioneer.

For Example:

If

then

the Request URL to test in Postman is:

http://carbon.C6pioneer.com:9505/procountinterop/rest/status



All IFS Application Request URLs

TABLE 1.2 provides the request URL format and an example URL for each IFS product.

IFS APPLICATION 

URL Format 

EXAMPLE REQUEST URL

IFS APPLICATION 

URL Format 

EXAMPLE REQUEST URL

IFS Enterprise Upstream 

http://[SystemServiceUri]/procountinterop/rest/status

http://carbonEU.C6pioneer.com:9505/procountinterop/rest/status

IFS BOLO and IFS Merrick

http://[SystemServiceUri]/[Deployment_Directory]/procountinterop/rest/status

http://ifsmidcapwebservice.awsc6pioneer.local/IFSMidcapWebService||EnvironmentType/procountinterop/rest/status

IFS BOLO and  IFS Land

http://[SystemServiceUri]/ping

http://carbonBOLOLand.awsC6pioneer.local:5001/ping

IFS Excalibur 

http://[SystemServiceUri]/ping

http://carbonSword:5002/ping

IFS AFE 

http://[SystemServiceUri]/rest/ifsafe/api/v1/status

http://carbonAFE:83/ifsafe/rest/api/v1/status

IFS Qbyte FM 

http://[SystemServiceUri]/v1/status

http://carbonFM.pioneer.com:8080/fm/v1/status

IFS Merrick (for all ProCount sites) 

http://[SystemServiceUri]/Alive

http://carbonMerrick:83/ifsafe/rest/api/v1/alive

IFS Land and iLandman

http://[SystemServiceUri]/api/status

http://carbonland.awsc6pioneer.local/ifslandserviceProd/api/status

IFS Land and Accounting

http://[SystemServiceUri]/api/status

http://carbonland.awsc6pioneer.local/api-platform/api/status

iLandMan

http://[SystemServiceUri]/ping

https://api.carbonilandman.com/2.0/ping

TABLE 1.2 Request URLs for IFS Applications

Notes:

  • Substitute SystemServiceUri with the Server on which the IFS Application web services are deployed on.

  • IFS AFE and Qbyte FM - When testing the Request URLs for these applications, in Postman, ensure that the Header is set with the following values:

    • Key of P2-Context 

    • Value of the Organization Token/Security Token for the IFS Application.

For more information on the Organization Token/Security Token, refer to the IFS AFE and Qbyte FM installation guides.



IFS BOLO Specific Request URLs for IFS ProCount Integration

WEB SERVICE  

METHOD  TO USE 

URL FORMAT 

WEB SERVICE  

METHOD  TO USE 

URL FORMAT 

Status  

GET 

http:// ifsmidcapwebservice.awsc6pioneer.local/ IFSMidcapWebService||EnvironmentType/procountinterop/rest/status

Parties 

GET 

http:// ifsmidcapwebservice.awsc6pioneer.local/IFSMidcapWebService||EnvironmentType /procountinterop/rest/parties?ProdIntegStatus=T&ProductionInstance=[ProductionInstance]

Wells and Completions 

GET

http://ifsmidcapwebservice.awsc6pioneer.local/IFSMidcapWebService||EnvironmentType/procountinterop/rest/wells?ProdIntegStatus=T&ProductionInstance=[ProductionInstance]



Notes:

  • For IFS BOLO integration with IFS ProCount, the SystemServiceUri comprises the following: 

    • The server on which the IFSMidCap Web Services are deployed 

    • The folder in which these Web Services are installed as depicted in the Web Services Installation Guide for IFS BOLO (IFSMidcapWebService concatenated with the Environment Type value provided by the system administrator during the installation process). 

Example: http://ifsmidcapwebservice.awsc6pioneer.local/IFSMidcapWebService||EnvironmentType/procountinterop/rest/status

  • For IFS BOLO integration with IFS ProCount, when testing the Request URLs, ensure that the Header is set in Postman with the following values provided by the system administrator during the installation process as depicted in the Web Services Installation Guide for IFS BOLO: 

    • Key of OrganizationID 

    • Value of OrgId

  • The value for the ProductionInstance will need to be replaced with the IFS ProCount instance defined in Codes in IFS BOLO or in the P2Systems table on the Connector. The value of ProductionInstance is configured by the user. 

Example:  http://ifsmidcapwebservice.awsc6pioneer.local/IFSMidcapWebService||EnvironmentType/procountinterop/rest/parties?ProdIntegStatus=T&ProductionInstance=2

  • The ProdIntegStatus variable should always have the value of T.

  • The value for ifsmidcapwebservice.awsc6pioneer.local will need to be replaced with the server on which the IFS BOLO web services for IFS ProCount integration are deployed on.

  • The value of EnvironmentType will need to be replaced with the value provided by the system administrator during the IFS BOLO web services installation process

Note: For more information, see the Web Services Installation Guide for IFS BOLO and IFS Excalibur.



IFS Enterprise Upstream Specific Request URLs

WEB SERVICE  

METHOD  TO USE 

URL FORMAT 

WEB SERVICE  

METHOD  TO USE 

URL FORMAT 

Status  

GET 

http://[server]:[port]/procountinterop/rest/status

Parties 

GET 

http://[server]:[port]/procountinterop/rest/parties?ProdIntegStatus=T&ProductionInstance=[ProductionInstance]

Wells and Completions 

GET

http://[server]:[port]/procountinterop/rest/wells?ProdIntegStatus=T&ProductionInstance=[ProductionInstance]



Note:

  • The value for the ProductionInstance will need to be replaced with the IFS Merrick ProCount instance defined in Codes in IFS Enterprise Upstream or in the P2Systems table on the Connector. The value of ProductionInstance is configured by the user. For example: 

http://carbon.C6pioneer.com:9505/procountinterop/rest/parties?ProdIntegStatus=T&ProductionInstance=2

  • The ProdIntegStatus variable should always have the value of T.

  • The value for server will need to be replaced with the server on which the tomcat server and EU procountinterop.war is deployed on.

  • The value for port will need to be replaced with the port on which tomcat server is configured for the web services.




Copyright© 2024 IFS AB. Copying prohibited. All rights reserved.