StediDOCS

Tutorials overview

Updated June 22, 2022

This section outlines different ways that the Stedi APIs can be used to build production EDI systems.

  1. Inbound EDI using Terraform outlines the architecture for a simple serverless system that (1) ingests EDI files and (2) outputs transformed JSON.
  2. Getting started with Mappings outlines how to (1) build a JSON to JSON mapping and (2) call it programmatically via the Mappings API.

These are only a few examples of how Stedi can be used today. The diagram below outlines how each API can be stitched together differently to accomplish whatever transformation goal your system requires.

Payload Transformations

EDI to CSV

A flow chart showing how to get from EDI to CSV
Learn more

Prerequisites:

  1. Get your input file: the sample EDI.
  2. Get your output file: the sample CSV.
  3. Transform the input EDI into JSON EDI (“JEDI”) via the Inspector or the EDI Core API to use for your mapping.
  4. Transform the output CSV into a “JSON-to-become-a-CSV” shape using the Converter API to use for your mapping.
  5. Create a new Stedi Mapping, using the input JEDI file as the Source JSON and the output “JSON-to-become-CSV” as the Target JSON. An example of this mapping can be found here.

Flow instructions:

  1. Use the EDI Core API to translate the EDI file into a JEDI file.
  2. Then, use the Mapping API to map the JEDI file to the “JSON-to-become-a-CSV” shape.
  3. Finally, use the Converter API to convert the “JSON-to-become-a-CSV” file into CSV.

EDI to JSON

A flow chart showing how to get from EDI to JSON
Learn more

Prerequisites:

  1. Get your input file: the sample EDI.
  2. Get your output file: the sample JSON.
  3. Transform the input EDI into JSON EDI (“JEDI”) via the Inspector or the EDI Core API to use for your mapping.
  4. Create a new Stedi Mapping, using the input JEDI file as the Source JSON and the output “JSON-to-become-CSV” as the Target JSON. An example of this mapping can be found here.

Flow instructions:

  1. Use the EDI Core API to translate the EDI file into a JEDI file.
  2. Then, use the Mapping API to map the JEDI to the JSON shape.

EDI to EDI

A flow chart showing how to get from EDI to EDI
Learn more

Prerequisites:

  1. Get your input file: the sample EDI 850.
  2. Get your output file: the sample EDI 855.
  3. Transform the input EDI into JSON EDI (“JEDI”) 850 via the Inspector or the EDI Core API to use for your mapping.
  4. Transform the target EDI into JSON EDI (“JEDI”) 855 via the Inspector or the EDI Core API to use for your mapping.
  5. Create a new Stedi Mapping, using the input JEDI 850 as the Source JSON and the output JEDI 855 as the Target JSON.

Flow instructions:

  1. Use the EDI Core API to translate the input EDI 850 file into a JEDI 850 shape.
  2. Then, use the Mapping API to map the JEDI 850 to the JEDI 855 shape.
  3. Finally, use the EDI Core API to generate an EDI 855 from the JEDI 855 shape.

JSON to EDI

A flow chart showing how to get from JSON to EDI
Learn more

Prerequisites:

  1. Get your input file: the sample JSON object.
  2. Get your output file: the sample EDI file.
  3. Transform the output EDI into JSON EDI (“JEDI”) via the Inspector or the EDI Core API to use for your mapping.
  4. Create a new Stedi Mapping, using the input JSON as the Source JSON and the output JEDI file as the Target JSON. An example of this mapping can be found here.

Flow instructions:

  1. Use the Mapping API to map the input JSON object to the output JEDI file.
  2. Then, use the EDI Core API to generate EDI from the JEDI file.

JSON to CSV

A flow chart showing how to get from JSON to CSV
Learn more

Prerequisites:

  1. Get your input file: the sample JSON object.

Flow instructions:

  1. Transform the JSON object to CSV via the Converter API.

XML to JSON

A flow chart showing how to get from XML to JSON
Learn more

Prerequisites:

  1. Get your input file: the sample CSV shape.

Flow instructions:

  1. Use the Converter API to convert the CSV into JSON.

XML to CSV

A flow chart showing how to get from XML to CSV
Learn more

Prerequisites:

  1. Get your input file: the sample XML.
  2. Get your output file: the sample CSV.
  3. Transform the input XML into a JSON object by calling the Converter API.
  4. Transform the output CSV into a JSON object by calling the Converter API.
  5. Create a new Stedi Mapping, using the input JSON object (former XML) as the Source JSON and the output JSON object (former CSV) as the Target JSON. An example of this mapping can be found here.

Flow instructions:

  1. Use the Converter API to parse the XML into a JSON object.
  2. Use the Mapping API to map the input JSON object (former XML) to the output JSON object (former CSV).
  3. Then, use the Converter API to convert the output JSON (former CSV) object to CSV.

CSV to EDI

A flow chart showing how to get from CSV to EDI
Learn more

Prerequisites:

  1. Get your input file: the sample CSV.
  2. Get your output file: the sample EDI.
  3. Transform the input CSV into a JSON object via the Converter API to use for your mapping.
  4. Transform the EDI to JSON EDI (“JEDI”) via the Inspector or the EDI Core API to use for your mapping.
  5. Create a new Stedi mapping, using the input JSON object (former CSV) as the Source JSON and the output JEDI file as the Target JSON. An example of this mapping can be found here.

Flow instructions:

  1. Use the Converter API to convert the JSON object to CSV.
  2. Use the Mapping API to map the input JSON shape to the output JEDI shape.
  3. Then, use the EDI Core API to generate EDI from the JEDI shape.