Integration

A service API is provided to allow integration to the NIAPS.

Obtaining a bearer token

In order to use the APIs, you must obtain a bearer token from Identity.

Full details can be found in the platform documentation

The scope for the request is "service.admin.api".

The client ID - which ties the bearer token to the Tenant - and secret are obtained by a Service Request to the DTT team.

Base URL's

The Base locations () are given in the Platform Documentation.

Note

The location of the service API is given below.
The previous swagger was at <base location>/tasservice/swagger/index.html (e.g. for pre-production dtt - https://dttapitenant-ppd.public.nics.gov.uk/admin/swagger/index.html). However, so that no changes are required to consumers of the API, calls to the old location are "proxied" to the new location.
A http request to any location under https://dttapitenant-ppd.public.nics.gov.uk/admin/api/Appeals/ is forwarded to https://dttapitenant-ppd.public.nics.gov.uk/tasservice/api/Appeals/

Important

The API itself has remained exactly as is and can still be called using the same URL's. There is no impact on users of the API.

The swagger for the api can be found at:

• <base location>/tasservice/swagger/index.html

i.e. https://dttapitenant-ppd.public.nics.gov.uk/tasservice/swagger/index.html for ppd and https://dttapitenant.public.nics.gov.uk/tasservice/swagger/index.html for production.