Monitoring

The Monitoring feature comprises of two elements: The API to supervise productive data streams and the reporting for the feedback process.

Sending requests

Sending a simple test request

Prerequisite

You have a valid API key.
You have licensed a Validation Interface and know its interface and process name.
You know your tenant ID (you will get it during the creation of your Cargogear tenant).
You have a test message for the selected Validation Interface.
You have an email address for the reporting email.
We recommend using an API test tool.

Steps

Open the API test tool of your choice.
Create a new request and choose POST as your HTTP action.
Adjust the following URL by your Cargogear instance name and set it in your request:
https://PLACEHOLDER.cargogear.io/validation_exec/api/v1/reports/edifact/generate/json
In the Headers section, set 'x-api-key' as header and the API key as value.
If not automatically set by your API test tool, set 'application/json' as value for the header 'Content-Type'.
In the body section, set the following JSON document, replacing the placeholders with real values.
- message_type: A string with the name of the Validation Interface. Please check for typos!
- process: A string with the process name of the Validation Interface. Please check for typos!
- content: A string without line breaks containing the test message.
- format: A string with the data format. Allowed values are 'EDIFACT' and 'ANSIX12'.
- tenant_id: A number to identify your tenant on your Cargogear instance.
- email_receivers: An array of addresses where a notification email is sent to if the message contained flaws. Each element is of type “address”.
- address: A string with the email address where the notification email should be sent to.
```
{
  "message_type": "MY_INTERFACE_NAME",
  "process": "MY_PROCESS_NAME",
  "content": "THE_MESSAGE",
  "format": "EDIFACT",
  "tenant_id": 1,
  "email_receivers": [ { "address": "test@test.com" } ]
}
```
Send the request.

You should get the HTTP status code 200.

For any other status code, please check the response and fix the request accordingly.

Adding identifiers to a validation request

You can add identifiers to your requests to process the result, e.g. in your EDI system. For example, if you add an reference ID, you could use that information to assign a validation result to an EDI workflow that is on hold until you get back that result. This is the list of available references:

file_name: A string that should contain the file name or virtual file name as you got it or created it during the EDI transmission.
partner_ref_ext: A string with a technical or business identifier for the data sender. Example: A supplier number. Please note: We use this value to identify a partner in the Cargogear platform. Therefore, please make sure to use unique values for each partner.
partner_ref_int: A string that could contain an additional identifier for a partner. Example: A single location of a supplier.
ref_id: A string to identify a single message like a document ID or an invoice number.

{
  "message_type": "MY_INTERFACE_NAME",
  "process": "MY_PROCESS_NAME",
  "content": "THE_MESSAGE",
  "format": "EDIFACT",
  "tenant_id": 1,
  "partner_ref_ext": "ARBIRARY_REF_EXTERNAL",
  "partner_ref_int": "ARBITRARY_INTERNAL_IDENTIFIER",
  "ref_id": "ID_TO_FIND_IT",
  "email_receivers": [ { "address": "test@test.com" } ]
}

Reporting