StediDOCS
GuidesAPI Reference
This product is in Developer Preview

Parameters

Getting Started

Parameters provides an interface for developers to define, create, and store structured data that can be referenced programmatically, enabling customers to build scalable EDI integrations.

With Parameters, Stedi is equipping developers with a key piece of missing self-service functionality they need to build reliable, secure, and scalable EDI integrations. Parameters can be used to solve a wide variety of common use cases, such as storing important variables like 3rd party integration keys, configuration values, datastore credentials, and passwords – or for building and accessing 'lookup tables', which are commonly used in the EDI world to transform values like SKUs or shipping methods when integrating disparate systems.

Authoring a Parameter

Parameters can be created using Terminal, API or Formation.

Using Formation

Formation is Stedi's infrastructure as code product for automated provisioning and management of platform configuration. With Formation you can automate the provisioning of Parameters.

A minimal example of a Formation file setting up a single Parameter of object type:

Resources:
  MyParameter:
    Type: "Stedi::Parameter"
    Properties:
      Id: "MyParameter"
      Type: "object"
      InitialValue:
        integrationId: "xxyyzz"
        apiKey: "INITIAL_KEY_VALUE_TO_BE_REPLACED"

or number type:

Resources:
  MyNumberParameter:
    Type: "Stedi::Parameter"
    Properties:
      Id: "MyNumberParameter"
      Type: "number"
      InitialValue: 0

or string type:

Resources:
  MyStringParameter:
    Type: "Stedi::Parameter"
    Properties:
      Id: "MyStringParameter"
      Type: "string"
      InitialValue: "INITIAL_VALUE_TO_BE_REPLACED"

Parameters with and without Schema

In order to maintain data integrity, shape and validity, a parameter of object type can be initialized with a Schema. If schema_id is supplied to the Upsert Parameter operation, the value of the parameter will be validated against the referenced schema. Moreover, all future update operations will be validated as well.

Using the API

The Parameters API is a JSON REST API. Please consult Parameters HTTP Reference for the endpoints that are available.

Limits

Parameters can store any data shape. However, simple data shapes are recommended. Moreover, every parameter must be smaller than 400 Kb. If a parameter exceeds this limit, consider splitting it into mutliple smaller Parameters.

Autogenerated Parameter UI forms

Refer to Parameter UI forms for more details.

API Reference

Getting StartedAuthoring a ParameterUsing FormationParameters with and without SchemaUsing the APILimitsAutogenerated Parameter UI forms