README.md

DX-resource-proxy-server(rs-proxy-server)

Introduction

The DX Resource proxy server is Data Exchange(DX) data access portal. It also facilitates data providers to register a connector to process the request and allows consumers to access data in accordance with the provider's access policies. The server ensures secure data access by integrating with an authorization server, requiring consumers to present access tokens validated through token introspection APIs before serving protected data and supports advanced search functionalities like temporal and geo-spatial queries. Consumers can access the data using HTTPs protocols.

Features

• Provides data access from available resources using standard APIs.
• Search and count APIs for searching through available data: Support for Complex (Temporal + Attribute), Temporal ( Before, during, After) and Attribute searches.
• Integration with authorization server (token introspection) to serve private data as per the access control policies set by the provider
• Automate connector registration process for data provider
• Integrates with DX Auditing server for logging and auditing the access for metering purposes
• Secure data access over TLS
• Scalable, service mesh architecture based implementation using open source components: Vert.X API framework, Postgres and RabbitMQ.
• Hazelcast and Zookeeper based cluster management and service discovery

Explanation

Understanding Rs Proxy Server

• The section available here explains the components/services used in implementing the RS-proxy-server
• To try out the APIs, import the API collection, postman environment files in postman

Reference : postman-collection, postman-environment

How To Guide

Setup and Installation

Setup and Installation guide is available here

Tutorial

Refer video for reference: Watch Video

Reference

API Docs

API docs are available here

FAQ

FAQs are available here