Skip to main content

API Keys

This document describes the process required to register an API Key from either any of our API providers. This document does not cover advanced API key management, restrictions and security. For advanced configuration, please refer to the vendor's documentation. Each customer can decide to use either provider for their services.

Multiple main options can be configured in Eftsure inside D365: Gov Codes, Maps, Places autocompletion

You can use any combination of providers for these separate services, although it is logical to use a single provider for all maps services. At the time of writing, the following services are supported:

  • ABN, NZBN, UEN, VIES, HMRC UK
  • Bing Maps & Bing Suggestions
  • Google Maps & Google AutoComplete
  • Mapbox Maps

Government Code APIs

VIES

Create an account at :

https://viesapi.eu/sign-in/

Go to Plan details, select and purchase the appropriate plan.

VIES Plans

Go to API Keys,

API Keys

Click Generate new key and copy / paste the identifier and key into Eftsure parameters > GovCode > Europe > VIES

HMRC UK

Create a new account at developer hub

Create a new application

Application details

Create a client Id and Secret, subscribe to Check a UK VAT Number

Subscription

ABN - Australia

Go to WebServicesAgreement

WebServicesAgreement

Accept Terms and Conditions

Complete your registration information

Complete registration

Your registration should be validated withing 24-48h, and the registrant will receive ABR notifications and scheduler maintenance such as:

Confirmation

NZBN - New Zealand

Login to portal.api.business.govt.nz/

Go to portal.api.business.govt.nz/product#product=nzbn

NZBN Portal

Click Subscribe button in Green.

Go to Terms and Conditions

Return a signed copy of the MBIE API Access agreement by email:

Agreement document

Terms and conditions

Once Subscription is approved, then the API Keys will be available in your subscriptions.

Available subscriptions

UEN - Singapore

UEN service is provided by ACRA - www.acra.gov.sg/

The UEN service uses OAuth 2.0 with Token generation to fetch data from ACRA webservices.

To use this service, you will need to purchase a Query package.

Go to www.bizfile.gov.sg/apimarketplace and subscribe to the Entity Information Query APIs.

Data APIs

www.bizfile.gov.sg/apimarketplace/categories/data-api/eiq

Purchase of the query packages below:

Plans

After purchasing the above packages, go back to bizfile and configure a new application for production.

Environments

Click Create app

UEN Application

Then generate a new OAuth Client Id and Secret to be used from Eftsure inside D365.

UEN Authentication

Then enter Client Id and Secret into Eftsure parameters > GovCode > Singapore > UEN

UEN Configuration

You can also check the balance of your credits:

UEN Credits

TIN - United States of America

TIN service is provided by EINSearch - einsearch.com/

The TIN Token used for Eftsure inside D365 F&O can be purchased from einsearch. Then refresh the token by entering your token on the dedicated configuration page:

TIN Configuration

Maps APIs

Most features are available for Bing Maps, Google Maps and Mapbox. The following documentation describes how to get an API key to use our services.

Bing Maps APIs

General

For Bing Maps, a single API key needs to be configured for the project and can achieve

For more information, please visit Microsoft site directly:

Getting Started

Licensing

Simple key creation

Go to Bing Maps Dev Center www.bingmapsportal.com/

Login with a Microsoft account.

Login into Bing Maps

Go to My account > My Keys > Create a new key

Create new key

Enter Application name, Key type = Basic, Application type = Website, Create

Create application

When the process completes, the following message is displayed:

Confirmation

After a few minutes, the following key will be displayed:

Bing maps key

Click Show key, copy the key and paste it into D365 Eftsure parameters form.

info

The same key can be used for Maps and Places.

Google Maps APIs

General

3 different APIs are used from Google Maps APIs and can be activated independently for different options.

For more information, please visit Google site directly:

developers.google.com/maps

Billing

Simple key creation

Go to Google Cloud console console.cloud.google.com/

Login with a Google account, create or select an existing project to hold the API Key, and navigate to API & Services:

Google Maps API Services

Select Enable APIs and services

Choose your services

Enable Maps Javascript API for Maps to allow displaying maps into the user interface - Optional JS API for maps

Enable Places API for Places to allow international address autocompletion - Optional

Places API

Enable Geocoding API to allow converting addressing into geographic coordinates - Optional

Geocoding API

Once enabled, the API will look like the following:

Overview

Go to Credentials and select Create Credentials:

Credentials

Select API Key:

API Key

Once completed, the following screen will be displayed, use the copy button and paste it into D365 Eftsure parameters form.

Summary

Mapbox API

General

Mapbox is an American provider of custom online maps for websites and applications, currently allowed in China...

A simple API key is required for these options.

Simple key creation

Go to account.mapbox.com/ and login with a mapbox account.

Select Create a token:

Mapbox account

Enter a token name and leave default values and select Create token:

Mapbox token

Select the copy button and paste the API key into D365 Eftsure parameters form.

Mapbox configuration