Connect your An Post API key

EirLink creates labels through your own An Post eCommHub account. You connect it once by pasting your eCommHub API key into EirLink. This page shows where the key lives, how to add it, and what to check if An Post keeps rejecting it.

Before you start

• You need an An Post eCommHub business account. It is the same site you book parcels in today.
• API access has to be enabled on the account. If you have never used an integration before, your An Post account manager can switch it on.

Find your key in eCommHub

1. Log in at ecommhub.anpost.com.
2. Open the page called External Connections To The System.
3. Under API Settings, copy the API key. Make sure you get the whole thing.

Add it to EirLink

1. In EirLink open Settings, then the An Post tab.
2. Paste the key and press Verify & save.

EirLink checks the key against the live An Post API before saving it, and stores it encrypted. Once the check passes you are connected, and labels you create bill straight to your An Post account.

The whitelist setting

On the eCommHub page you will see Use Whitelist switched on and greyed out. That is normal. It is on for every account and you cannot turn it off. What matters is the list under it.

If no whitelist is selected, the API works from any IP address and there is nothing to do. If a whitelist is selected, An Post only accepts your key from those IP addresses, which blocks EirLink and makes the key show as rejected. Remove the selection and save.

API limits and label type

On the same page, API Limits controls how many requests per minute your key allows for Booking and Other. If either is blank or 0, An Post can refuse every request. Set both to something sensible like 60. Label type should be set to API.

Key rejected?

If EirLink says An Post rejected the key, go through this list in order:

• Nothing is selected under Use Whitelist.
• The Booking and Other limits are not blank or 0.
• Label type is API.
• Regenerate the key in eCommHub and paste the new one into EirLink straight away. Regenerating kills the old key, so any copy you took earlier stops working.
• Still rejected? API access may not be active on your account yet. Your An Post account manager can confirm, or email us at contact@eirlink.ie and we will help you get to the bottom of it.