Capturing External Connection Information
Background
To set up a secure MTLS connection with an external endpoint, ensure that the prerequisites such as the endpoint’s base-URL, URL fragments, client key-certificates, and server certificates are available in Windchill+. This information is used in the CCD utility to generate the SSL context.
Follow the Steps to Share Connection Information with PTC
After setting up the materialAPI, ensure that you have the following information:
◦ Base-URL
◦ Client-keycertchain
◦ Server-certchain
In addition, you should have the BLOB_SAS_URL and a public key for encryption received from PTC.
2. Prepare a JSON file by replacing the placeholders mentioned in the following sample JSON file with your actual parameters.
MaterialAPI JSON
{
"blob_sas_url": "***replace with BLOB_SAS_URL received from PTC***",
"external_connections": {
"material_api": {
"baseurl": "***replace with your base-url***",
"secrets": {
"client_cert": "***replace with path to clientcertchain***",
"bearer_token": "***replace with your bearer token***"
},
"server_cert": "***replace with path to clientcertchain***",
"url_fragments": {
"get_material_number": "/api/material",
"get_material_data_stream": "/api/materialData/stream"
}
}
},
"public_key_for_encrypting_custom_secrets":"***replace with your public key for encryption received from PTC ***",
"apply_at":"***schedule atleast 1 hour after execution-time of utility***"
}
3. Specify the path to your JSON file and execute the capturExternalConnections utility from ${WT_HOME}/bin/captureExternalConnections.sh
./captureExternalConnections.sh -f <***path-to-your-json***>
If the external information is successfully captured, the following message appears: “Connection information submitted successfully.”