Documentation

Your Account & API key

Article author
Admin
  • Updated

Your API Key for EdiNation and EdiFabric

Free Plans

You don't need an account to use EdiNation's free plan or the free trials for EdiFabric and EdiNation InHouse. The keys below are free for evaluation:

  • EdiNation Free Plan

    3ecf6b1c5cf34bd797a5f4c57951a1cf
  • EdiFabric and EdiNation InHouse

    c417cb9dd9d54297a55c032a74c87996

 

Paid Plans

When you subscribe to a paid plan, either for EdiNation or EdiFabric, you'll be provided with a separate API key

  1. To get your API key, go to www.edination.com, click the user icon in the top-right corner, then select Sign-in:

    api-key-login.png

  2. Your username is the email address you used during the purchase. If logging in for the first time, select Forgot your password? to set up a new password. Check your junk email or firewall rules for the password confirmation email if you are still waiting to receive it within 15 minutes.

    api-key-password.png

  3. After you log in, select Get API key and wait for your API key to be displayed:

    api-key-get.png

  4. Select and copy your API key:

    api-key.png

  5. (Optional) Install your API key in the browser for EdiNation Web EDI Translator by clicking on Install:

    api-key-install.png

    This only installs the API key in the browser for use with EdiNation Web EDI Translator. Refer to the next steps if you want to use the key with EdiNation API, EdiNation InHouse, or EdiFabric EDI Tools.

    Your API key is now available in the settings and is ready for use in the EdiNation Web EDI Translator:

    edination-api-key-settings.png

  6. 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

  7. 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.