Automate data upload

Transparent Supply APIs are provided for automating data uploads. To automate data upload, a registered Transparent Supply System user authenticates and then uploads conforming XML data for your organization.

Event data rules

Apply the following rules when you are automating your EPCIS event uploads to Transparent Supply:

  • Event IDs must be unique to be viewed in the Transparent Supply UI. Using UUIDs is recommended.
  • Any duplicate event IDs are replaced in the UI by the most recent upload, but are not overwritten on blockchain.
  • An erroneous event upload cannot be removed from blockchain, but it can be removed from the Transparent Supply UI by uploading a new event with an identical Event ID.
  • Events cannot be combined into a single event. For example, a commission event is required when a product instance is created and an aggregation event is required when the product is packed and shipped.
  • The sequential ordering of supply chain events is determined by the event timestamps in the XML. The order in which the events are uploaded has no effect on the sequential ordering of the supply chain events.

Automation procedure

To automated data uploads to Transparent Supply:  
  1. Generate a Transparent Supply service token (JSON Web Token) by using API Authentication.
  2. Provide the Transparent Supply service token in the authorization header on each API call in the format Bearer ONBOARDING_TOKEN_VALUE. A successful upload returns an HTTP 201 message that includes the created Transparent Supply asset ID.
  3. Generate new Transparent Supply service tokens as required. If an expired Transparent Supply service token is specified in an API call, an HTTP 401 (Unauthorized) message is returned.
    Note: Transparent Supply service tokens expire after 1 hour. New tokens can be generated at any time, including before the current token expires.