Documentation

Your Account & API key

Article author
Admin
  • Updated

Free Plans

EdiFabric EDI Tools and EdiNation InHouse

To evaluate EdiFabric EDI Tools or EdiNation InHouse use the following provisional key:

c417cb9dd9d54297a55c032a74c87996

 

EdiNation and EdiNation Developer API

EdiNation Portal comes with a free plan and a preconfigured API key. To evaluate the Developer API, use the following provisional API key:

3ecf6b1c5cf34bd797a5f4c57951a1cf

 

Paid Plans

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

 

How do I get my API/serial key?

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

    edination-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 a new password. Check your spam or junk folder, or your firewall rules, if you still haven't received the password confirmation email within 15 minutes.

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

    edination-get-apikey.png
  4. Select and copy your API key:

    edination-profile.png
  5. (Optional) Install your API key in the browser for EdiNation only if you want to upload and use private custom models by clicking on Install:

    edination-install.png

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

 

How to install my API/serial key?

EdiNation

The free key is preconfigured, so you don't need to install anything. If you wish to install your paid key when working with custom models, more information here, install your API key by clicking on the key button:

edination-private-key.png

Then paste your paid key and save it for future use with the portal:

edination-private-key-save.png

 

EdiNation Developer API

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

For evaluation, use the free API key for the Developer API: 3ecf6b1c5cf34bd797a5f4c57951a1cf

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

 

EdiFabric EDI Tools

To learn more about how to use your EdiFabric EDI Tools, go to the EdiFabric Serial Key Authentication article.

To install your EdiFabric serial key, go to the How to Install EDI Tools for .NET article.

To upgrade from the trial, go to the How to Upgrade from the Trial article.

 

Monitor your EdiNation Developer API Usage 

Every EdiNation paid 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. Once you reach the quota limit, depending on your plan, any subsequent API calls will either fail (for plans without overage) or incur an overage fee per call (as specified in the plan).

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

The quota period starts when your subscription begins and ends after the specified number of days, according to your plan (usually 30 days).

The EdiNation portal does not count towards the quota; only the EdiNation Developer API does.

 

View your usage

To view your usage data, log in to the developer portal and select the "Reports" menu:

api-usage.png

 

We also recommend that you implement internal counters for every call to the Developer API and frequently verify that they match the numbers we report to avoid incurring overage charges.

 

Manage Your EdiNation Account

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

edination-manage-billing.png

 

Wait for the billing portal to load and go to manage your subscription. 

edination-billing-portal.png

In the billing portal, you can change your payment method, download previous invoices, or cancel your subscription.

In case you can't log in to your portal, send us an email on support@edifabric.com or go directly to the customer portal, to manage your account.

 

Cancel Your Subscription

To cancel your EdiFabric or EdiNation subscription, 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 usage history for all previous periods.

 

Share this:

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.