Documentation

Search

Introduction

Article author
Admin
  • Updated

ediFabric Cloud is a REST API that reads, writes, validates, and acknowledges EDI. You send a file or JSON and get JSON or EDI back. It is the same product as ediFabric .NET and Native: one serial key, and Cloud calls count toward the same plan.

Sign up free for Community   API reference

Call it

  1. Sign up for Community and copy the serial from Your Account. That serial is the API key. The same value is what .NET passes to License.SetSerial and what Native passes to set_serial.
  2. Send it on every request as the Ocp-Apim-Subscription-Key header. All calls use HTTPS.
  3. POST the EDI file to https://api.edination.com/v2/x12/read (or the matching standard below).
curl -X POST "https://api.edination.com/v2/x12/read" \
  -H "Ocp-Apim-Subscription-Key: YOUR_SERIAL_KEY" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @purchase-order.edi

Treat the serial like a password. Do not commit it or ship it in browser code. Community is for non-production evaluation.

The API accepts application/octet-stream, multipart/form-data, or JSON. Responses are JSON or application/octet-stream. Property names are case-insensitive. Query parameters are UTF-8 and belong on the URL.

How Cloud is licensed

One operation is one parse, generate, validate, or acknowledge call. On Community that quota is shared with ediFabric .NET and Native. When the quota is used up, Cloud returns 403 Forbidden. .NET and Native throw LicenseException with error 639 for the same limit.

Plan Cloud
Community 250 operations per day, shared with .NET and Native. Public EDI models. Non-production. Never expires.
Developer 3,000 Cloud operations per month, then $0.01 each. Private custom models. Local .NET and Native operations are unlimited.
Enterprise 25,000 Cloud operations per month, then $0.008 each. Private custom models. Optional dedicated host api-{id}.edination.com.
Cloud only Hosted API with no .NET or Native license. First 1,000 operations each month are free, then $0.01. Private custom models.

Compare plans at edifabric.com/pricing. Use of the API is subject to the EULA.

Base URL

https://api.edination.com/v2

The current version is v2. A breaking change ships as a new version on that path. Enterprise dedicated hosts use https://api-{id}.edination.com/v2. The id is assigned with the plan.

Endpoints

Paths below are relative to the base URL. POST /x12/read is https://api.edination.com/v2/x12/read.

Verb Path What it does
POST /x12/read X12 file to JSON
POST /edifact/read EDIFACT file to JSON
POST /hl7/read HL7 file to JSON
POST /ncpdp/read NCPDP file to JSON
POST /vda/read VDA file to JSON
POST /x12/write X12 JSON to an X12 file
POST /edifact/write EDIFACT JSON to an EDIFACT file
POST /hl7/write HL7 JSON to an HL7 file
POST /ncpdp/write NCPDP JSON to an NCPDP file
POST /vda/write VDA JSON to a VDA file
POST /x12/validate Validate X12 JSON
POST /edifact/validate Validate EDIFACT JSON
POST /hl7/validate Validate HL7 JSON
POST /ncpdp/validate Validate NCPDP JSON
POST /vda/validate Validate VDA JSON
POST /x12/ack X12 997, 999, and TA1
POST /edifact/ack EDIFACT CONTRL

Upload EDI as application/octet-stream or multipart/form-data. Download generated EDI or acknowledgments as application/octet-stream. Models and errors are JSON, UTF-8.

Errors

2xx means the call succeeded. 4xx means the request was rejected (a missing header, a bad body, or a quota). 5xx means the service failed.

A failed body is still JSON, with Code and a Details array:

{
  "Code": 0,
  "Details": [
    "string"
  ]
}

403 Forbidden means the plan quota is used up. On Community that is the shared 250 operations per day.

Status and SDKs

API status reports Available, Degraded, or Unavailable.

Generate a client from the OpenAPI document on SwaggerHub.

Generate an SDK from the EdiNation API on SwaggerHub

Next

Share this:

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.