The TraceGains SOAP API provides access to your TraceGains Suppliers, Items, data, documents, and system configuration through several SOAP resources. Each SOAP resource targets a specific data set or configuration component in your TraceGains site.
You must make a formal request for API access to your Customer Success Manager. Once your TraceGains instance API access has been enabled, you will then have access to generate and manage your API keys and view your API logs.
Use of the TraceGains API is included with every Enterprise subscription, but may require additional license fees for Standard subscriptions. If you are running a Standard TraceGains license please contact your CSM for more information. API resources and methods are marked with an access legend that indicates which TraceGains module licenses are allowed to use that resource method.
API Access Legend: <Subscription Type> | <Supported Modules>
Enterprise Standard | SM SC SPM FM QM
Use of the TraceGains SOAP API requires a registered Application Key. You must create an Application Key using the Manage Keys view in a Supplier Management, Supplier Compliance or Quality Managment instance of TraceGains. The Manage Keys view link is accessed from the Configuration menu in a TraceGains instance.
At least 1 Application Key is required to use the TraceGains SOAP API. However, you may create a unique Application Key for each API interface you develop to access your TraceGains instance data.
Each SOAP resource has a specific Web Services Description Language (WSDL) XML file that can be accessed via web browser. The home page of each SOAP resource contains the clickable link Service Description to the resource WSDL in the following text The following operations are supported. For a formal definition, please review the Service Description.
Additional WSDL links are also provided on the documentation page of each SOAP resource.
A call to a SOAP resource method requires a registered Application Key and a valid Session ID, along with any additional parameters required by the method. A Session ID is obtained by making a call to the Login method of the Authentication resource. While a Session ID will expire automatically based on the configuration of the Application Key, TraceGains recommends that you make a call to the Logout method of the Authentication resource to expire a Session ID when it is no longer needed.
Example Authentication Workflow:
All API method responses include a standard HTTP status code in the ResponseCode element of the response.
Developers should treat the HTTP Status codes 200 and 202 in a response to indicate a successful SOAP request!
The HTTP Status Code 202 is used to indicate that a request was only partialy successful.Example: A method call passes 10 attributes but only 9 attributes were updated because the 10th attribute does not exist in your TraceGains instance. The unknown attribute may have been removed or it may not yet exist in your TraceGains instance configuration. In either case, we accept the attribute data we can validate and ignore the 10th attribute. The 202 response serves to indicate that you may have an issue in your interface code, but not one that is currently causing harm to your TraceGains instance data or configuration.
All connections to the API must be made using HTTPS over TLS 1.2. The API does not support connections made using HTTP or HTTPS over SSL 2.0, SSL 3.0, TLS 1.0 and TLS 1.1.
A developer sandbox with your live production data and configuration will be provisioned upon request. For more information regarding the provisioning of your site to the TraceGains sandbox environment, contact your TraceGains Customer Success Manager.
Your sandbox environment includes all resgistered User Accounts that were in your production instance of TraceGains at the time of provisioning. You may login to the environment, request password resets and create new accounts for additional developers in the sandbox instance as necessary.
The TraceGains sandbox instance environment is located here: https://test.TraceGains.net
The TraceGains sandbox API environment is located here: https://api-test.TraceGains.net/v7/soap/authentication.asmx
The TraceGains API does offer support for managing the Specification Publishing module attribute conigurations. The Business Rules API resource allows for managing the 3 properties IncludeInSpecPublishing, SpecificationName and SpecificationDescription for the BusinessRuleHeader of an Item attribute.
The TraceGains API only supports the en-US language tag specification. All text returned in the Message element of all SOAP responses will be in English as used in the Unites States.