Validation API

Automate and integrate Truugo validation using API

API endpoints

Add enhanced validation capabilities to your existing processes and applications using the Truugo Validation API.

list-profiles

Returns the test profiles for which the API license has granted access.

Save the list in the local cache to avoid unnecessary requests.

Validates a file instance against the selected test profile. The API will return the result as one of the following codes: FAILED, INVALID, PASSED, or VALID.

Validates a file instance against a selected test profile. Returns the test report in JSON format. No files are stored on the Truugo server.

Validates a file instance against a selected test profile. Returns the result as a code and URL pointing to the test report. Truugo stores the test report and the file instance on the storage for a maximum of 24 hours.

Equals the check-status request with the addition that Truugo stores the test statistics in a database for further analysis for (30|60) days.

Equals the get-report request with the addition that Truugo stores the test report and the file instance on the storage for up to (7|14|30) days.

Usage examples

Development

A developer needs to set up a translator for transforming a file from one message format to another. Using the Validation API, the developer can efficiently test and fix the translator as an iterative process. The get-report API request instantly returns a sensible test report to identify and locate all structure, content, and integrity issues at once. After the translator is ready, use the get-status API request to validate a batch of messages to detect also rarely occurring issues.

BENEFITS: Get faster implementation with better quality without extra effort.

Now and then, each company needs to make updates to its systems, processes, and message formats. Therefore, an efficient mechanism is required to ensure that everything works as expected after the changes. To ensure quality, you can use the get-status API request to validate a batch of messages after each update.

BENEFITS: Easy and efficient way to detect anomalies in message quality.

The help desk needs to solve issues quickly and cost-efficiently. However, the 1st/2nd level support does not usually have the knowledge and tools to solve technical issues. Thus these issues are forwarded to technical professionals, resulting in higher costs and longer response times.

The help desk gets an instant report on whether a message contains syntax, content, or integrity issues using the get-report API request. Thus only extreme cases need to be forwarded to technical professionals.

The help desk can easily share the test report with the trading partners. Using the store-report-(7|14|30)-d API request, the help desk can store the test report for X days to provide a trading partner with a convenient schedule for fixing the issue.

BENEFITS: Minimize lead time and costs. Provide harmonized and professional feedback for the trading partners. Allow technical professionals to allocate their time to more productive tasks.

The company wants to prevent invalid transaction data from causing critical issues and high costs for business processes. Therefore, they must apply automated validation to inbound/outbound messages to prevent invalid data from reaching the back-end systems. The get-status API request can be used as a gatekeeper to allow only valid messages to flow to the back-end systems. In addition, the get-report API request can be automatically run for all invalid messages to provide a detailed error report for the team responsible for the monitoring.

BENEFITS: Minimize costly issues and the time spent detecting and locating issues.

API pricing