Set up the Ideal Postcodes extension

This extension makes it easy to enter addresses in the United Kingdom (UK) for entities like customers, contacts, employees, vendors, bank accounts, and so on.

The Ideal Postcodes extension uses the Ideal Postcodes API to find addresses in postcodes in the UK. To use the extension, you need an Ideal Postcodes account, a plan, and an API Key for the Ideal Postcodes API. We help you access the latest plans when you set up the Ideal Postcodes extension in [!INCLUDE [prod_short](../../includes/prod_short.md)].

Plans are based on use, or what are sometimes referred to as "calls." A call, in this case, is when [!INCLUDE [prod_short](../../includes/prod_short.md)] displays a list of addresses in a postcode. Depending on how often you add addresses, choose the plan that's best for you.

To learn more about Ideal Postcodes, visit their website.

Get started

  1. [!INCLUDE [open-search](../../includes/open-search.md)], enter Service Connections, and then choose the related link.
  2. On the Service Connections page, choose UK Postcode Service.
  3. On the Postcode provider configuration page, choose Disabled.
  4. On the Postal code service selection page, choose IdealPostcodes.

  5. On the Ideal Postcodes Provider Setup page, choose Get API Key to open the Plans page on the website for the IdealPostcodes API.

    Hinweis

    You might need to allow pop-ups in your browser.

  6. Create an Ideal Postcodes account, and purchase a plan.

  7. Open the Ideal Postcodes account dashboard, and copy the API key.

  8. On the Ideal Postcodes Provider Setup page:

    1. In the API Key field, enter the API key.
    2. Read the Terms & Conditions.
    3. Select the Enabled checkbox, and then choose OK.

    4. Choose Actions, and then Test Connection. If the test was successful, the Connection test was successful message displays.

      Wichtig

      If the Connection test failed. Received response 0 message displays, the extension isn't allowed to make outbound HTTP calls. To fix the issue, search for Extension Management, select the IdealPostcodes extension, and turn on the Allow HttpClient Requests toggle. Then, test the connection again.

  9. To verify that your API key works, choose Test Connection.

    Hinweis

    If you're working in a sandbox environment, your Ideal Postcodes extension must allow HTTPClient requests. To verify that setting, open the Extension Management page, find the Ideal Postcodes extension, and then make sure that the Allow HttpClient Requests toggle is turned on.

  10. On the Service Connections page, verify that the Address Provider field contains Ideal Postcodes. If it does, the service is ready to use.

Ideal Postcodes extension in the British version
United Kingdom local functionality in the British version

[!INCLUDE [footer-banner](../../includes/footer-banner.md)]