https://di.no/doc

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

The AddressCheck service consists of two separate endpoints. The first accepts a batch of customer addresses to check, whereas the second returns the results if processing has completed:

Visit the links above to see detailed information about the two endpoints.

The rest of this document describes common aspects for both endpoints.

Authentication

Both endpoints require authentication, in order to access them you need a token that is accuired by doing a POST against this endpoint: https://ws.di.no/ws/json/auth/v-1/login

The post should have this structure:

{

      "username": "<user>",

      "password": "<password>"

}

Replace <user> and <password> with the values that you acquire from the DI helpdesk. The endpoint replies with a security token that should be placed in the Authorization header like this:

"Authorization: Bearer <token>"

 

The token is valid for 30 minutes and is a json web token ( https://jwt.io/ ) but can be handled as a plain string on the client side.

Concepts and notation

  • uuid : a unique identifier returned by the service when a batch of customer addresses are submitted for processing. Is used later in a subsequent request to inform the service which batch is targeted.
  • expiry : the results of a processed batch will expire a certain time after the request has been completed. The status of the batch is reported in the service response.
  • proxy timeout : describes when the service will cancel outstanding requests to other authorities / source systems. All associated customer addresses will be marked as not supported, and the auhority will be set to NOT_PROCESSED

Configuration parameters

Describes important configuration parameters affecting use of the service.

Server side

  • expiry time : 15 minutes after the request has been processed.  (TODO: Agree on / discuss this one)
  • job timeout : 90 minutes (TODO: Agree on / discuss this one)
  • maximum customer addresses per request : 10'000 (TODO: Agree on / discuss this one)

Client side

  • WS-Security:
    • username / password : a valid username and password is required to access the service.
    • webservice access : the user must be granted privileges to access the webservice(s)
  • No labels