Documentation

Your Account & API key

Article author
Admin
  • Updated

EdiNation 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 the following limitations:

  • Up to 50 API calls a day
  • Up to 6 API calls per minute
  • Maximum file size 3MB

The free plan comes with the following API key: 3ecf6b1c5cf34bd797a5f4c57951a1cf

This API key works only with EdiNation and NOT with EdiFabric EDI Tools or EdiNation InHouse!

 

EdiNation InHouse Free Trial

You must sign up for an account to use EdiNation's free trial. Use the API key provided in the account as your trial API key.

 

EdiFabric Free Trial

You don't need an account to use EdiFabric's free trial. You only need an account after purchasing the Subscription or the Enterprise plan from the pricing page.

The free trial is valid for 14 days and comes with the following API key: c417cb9dd9d54297a55c032a74c87996

This API key works only with EdiFabric EDI Tools and NOT with EdiNation or EdiNation InHouse!

For more information regarding EdiFabric trial go to this article.

For more information regarding EdiFabric serial key go to this article.

 

Your API Key

  1. When you subscribe to a paid plan, either for EdiNation or EdiFabric, you'll be provided with a separate API key by signing in to your account:

    edination-account.png

    If you are logging in for the first time, select Forgot your password? to set up a new password.

    edination-signin.png

  2. Then install your API key (this may take a few seconds):

    edination-api-key.png

    Your API key is now available in the settings:

    edination-api-key-settings.png

  3. Your API key is ready for use in the EdiNation Web EDI Translator. To use the API key to access the EdiNation API, set it as an HTTP header parameter:

    Ocp-Apim-Subscription-Key = {Your API key}

    api-key-api.png

  4. If you purchased EdiFabric EDI Tools, you can use the API key as your EdiFabric serial key.

You can also access your API key or generate a new one, if you have to, from the developer portal.

 

View EdiNation Usage Data

Every plan comes with a quota that defines how many API calls you are allowed for the duration of your term when 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, log in to the developer portal and select the "Reports" menu:

api-usage.png

 

Manage Your EdiNation 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.

 

Cancel Your EdiNation Account

To cancel your account sign in to your account and select 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.