Address Cleanser Process API

(0 reviews)

home

This API serves as a design for API Led Connectivity approach of running an enterprise. The Process API is to provide the cleansed address records from the EpiCX ecosystem. The purpose of this API is to provide a Mulesoft based wrapper to the the Reltio Address Cleanser API through Loqate. It is exposed to other downstream systems that require address validation to verify the existence and geolocation of a given address. It can also check whether an address already exists in the Reltio tenant.

The API allow users from target systems to be able to search cleansed address from the MDM through Loqate from the EpiCX ecosystem. User can send the Request in 2 ways.

option 1: Send the full address in a single attribute (AddressInput) as a string format.

resources/image-19625033-23bd-46c0-badc-c2fdd73d85a1.png

option 2: Address parameters separately in each attributes (City, Country, AddressLine, Zip etc..)

resources/image-ff5d1190-aed5-47a2-86e8-77ee3c4ed2bc.png

The API is designed as a REST API using RAML definition and uses JSON as an exchange format. Included are example requests and responses.

Implemented endpoints:
  • POST /addressCleanser: This endpoint can be used for the address cleanser functionality.

    API Hosted

  • Cloudhub

API Hosted Region

  • EU

System of Records

  • MDM Reltio

Dependencies

  • Elasticsearch System API

High Level Solution Diagram

resources/image-95eb9ce1-c229-40f5-be56-ed2e31c9fb23.png

API Sequence Diagram

resources/image-b7e64ee2-e55a-4f02-b065-c62aeb3616b1.png

Technical Details

Interested in knowing how it works behind the scenes? Further documentation on requirements and solution design can be found in the Roche wiki:

Release Notes

Version Status Release Date End-of-Life Date
v1.0 Latest Version TBD Guaranteed for minimum one year from the release date

When an API version is to be deprecated, advance notice is given at least one year before support ends. Consuming Apps are advised to check back regularly for new API versions and deprecation schedule.

v1.0 (Current)


Reviews