Documentation

Your Free Plan

Article author
Admin
  • Updated

So you want to give EdiNation a spin and want to understand what you can and can't do? You're in the right place!

 

Your Free Plan

You don't need an account to use EdiNation's free plan. You only need an account when subscribing to a paid plan, which you can do by signing up here.

The free plan allows you to use all features of EdiNation with a daily limit, as set out here

 

Your API Key

To use EdiNation you need an API key. The free plan comes with the following API key:

3ecf6b1c5cf34bd797a5f4c57951a1cf

When you subscribe to a paid plan, you'll be provided with a separate API key by signing in to your account:

edination-account.png

 

edination-api-key.png

You can use the API key to access:

  • EDI API - set it as an HTTP header parameter Ocp-Apim-Subscription-Key = {Your API key}
  • The Web EDI Translator - set it up here

 

Installing your API key

Once you have obtained an API key (see the previous paragraph), copy it and:

  • Install it in the browser for the Web EDI Translator:

    edination-api-key-install.png

  • Set it as an HTTP header when requesting the API:

    api-key-api.png

 

View Usage Data

Every plan comes with a quota that defines how many API calls you are allowed for the duration of your term, when does throttling kicks in, and what happens after you've reached your quota limits.

Every request to our API is measured as an API call. Upon reaching the quota limit and depending on your plan, any subsequent API calls will either fail (for plans without overage) or incur an overage fee per API call (as specified in the plan).

We alert developers via email when they are approaching 85% of their quota limit and have reached 100% of their quota limit.

The quota period starts at the time of your subscription and ends after the specified number of days according to your plan (usually 30 days) from that time.

Web EDI Translator uses two API calls every time you click any of the translation buttons, one API call for translation and one API call for validation.

The quota is shared between EDI API and Web EDI Translator when they are used with the same API key.

To view your usage data login to the developers portal and select the "Reports" menu:

api-usage.png

 

How to Manage your Account

You can manage your billing details by signing in to your account and selecting Manage billing:

edination-account-manage.png

edination-billing-portal.png

In the billing portal, you can download previous invoices, change your billing information or cancel your account.

 

How to Cancel your Account

To cancel your account sign in to your account and selecting Manage billing:

edination-cancel-account.png

Click on the "Cancel plan" button to close your account and cancel your plan. This will remove all the history of your usage for all previous periods.

 

Share this:

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.