BIS Data Portal Connector Integration

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

The BIS Data Portal Connector facilitates seamless integration with the BIS SDMX RESTful API v1.4.0, providing access to statistical data and metadata from the Bank for International Settlements (BIS). This connector acts as a proxy to streamline data retrieval, supporting actions for querying data, availability, dataflows, data structures, and schemes in XML, JSON, CSV, and EDI formats. It leverages SDMX standards for filtering by flow, key, periods, and details, enabling economic analysis, policy research, and financial applications with global banking statistics.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the BIS Data Portal Connector.

Supported Integration Action Points

getData: Retrieve data from a dataflow with key filtering.
getDataAvailability: Get information about data availability for components.
getDataflow: Retrieve a specific dataflow.
getDataStructure: Retrieve a specific data structure.
getCategoryScheme: Retrieve a specific category scheme.
getCodelist: Retrieve a specific codelist.
getConceptScheme: Retrieve a specific concept scheme.
getDataProviderScheme: Retrieve a specific data provider scheme.
getDataflows: Retrieve all dataflows.
getDataStructures: Retrieve all data structures.
getCategorySchemes: Retrieve all category schemes.
getCodelists: Retrieve all codelists.
getConceptSchemes: Retrieve all concept schemes.
getDataProviderSchemes: Retrieve all data provider schemes.
getDataflowsByAgency: Retrieve dataflows by agency.
getDataStructuresByAgency: Retrieve data structures by agency.
getCategorySchemesByAgency: Retrieve category schemes by agency.
getCodelistsByAgency: Retrieve codelists by agency.

Detailed Integration Documentation

2.1 Get Data Retrieval

Action	getData
Purpose	Retrieves data from a specified dataflow, filtered by key, periods, and detail level, in formats like JSON, XML, or CSV. This serves as the primary entry point for accessing BIS statistical data.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: flow: Dataflow identifier (string, e.g., BIS,CC,1.0) key: Data key (string, e.g., all or specific dimension values) Optional: startPeriod: Start period (string, e.g., 2020-Q1) endPeriod: End period (string, e.g., 2024-Q4) firstNObservations: First N observations (integer) lastNObservations: Last N observations (integer) detail: Level of detail (string, enum: [full, dataonly, serieskeysonly, nodata])
Output	Successful: JSON: SDMX-JSON with header, datasets, and structure details XML: SDMX-ML generic or structure-specific format CSV: Dimension codes or codes with labels Failure: Returns error details (e.g., 400: Bad syntax, 404: Not found)
Workflow Example	Configure the connector with the appropriate base URL Execute the getData action with flow=BIS,CC,1.0 and key=all Process the response to analyze credit to the private non-bank sector data

2.2 Get Data Availability Retrieval

Action	getDataAvailability
Purpose	Retrieves information about data availability for a specific component in a dataflow, supporting exact or available modes for query planning.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: flow: Dataflow identifier (string, e.g., BIS,CC,1.0) key: Data key (string) componentID: Component ID (string, e.g., FREQ) Optional: mode: Availability mode (string, enum: [exact, available], default: exact) references: Referenced artefacts (string, enum: [none, all, datastructure, conceptscheme, codelist, dataproviderscheme, dataflow], default: none) startPeriod: Start period (string) endPeriod: End period (string)
Output	Successful: Returns a JSON or XML object with ContentConstraint: Cube region with available values Failure: Returns error details (e.g., 400: Bad syntax, 404: Not found)
Workflow Example	Execute the getDataAvailability action with flow=BIS,CC,1.0, key=all, and componentID=FREQ Review availability for frequency dimensions Use to refine data queries

2.3 Get Dataflow Retrieval

Action	getDataflow
Purpose	Retrieves a specific dataflow by agency and ID, including structure and description for data understanding.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) flowID: Dataflow ID (string, e.g., CC) Optional: None
Output	Successful: Returns a JSON or XML object with Dataflow: Details including name, description, structure reference Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getDataflow action with agencyID=BIS and flowID=CC Review dataflow metadata Use for validating data queries

2.4 Get Data Structure Retrieval

Action	getDataStructure
Purpose	Retrieves a specific data structure definition by agency and ID, detailing dimensions and attributes.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) dsID: Data structure ID (string, e.g., DSD_CC) Optional: None
Output	Successful: Returns a JSON or XML object with DataStructure: Dimensions, attributes, codelists Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getDataStructure action with agencyID=BIS and dsID=DSD_CC Analyze structure for key dimensions Use for building query keys

2.5 Get Category Scheme Retrieval

Action	getCategoryScheme
Purpose	Retrieves a specific category scheme by agency and ID, for categorizing data.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) csID: Category scheme ID (string) Optional: None
Output	Successful: Returns a JSON or XML object with CategoryScheme: Categories and hierarchy Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getCategoryScheme action with agencyID=BIS and csID=CS_BIS Review categories Use for data classification

2.6 Get Codelist Retrieval

Action	getCodelist
Purpose	Retrieves a specific codelist by agency and ID, providing code-value mappings.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) clID: Codelist ID (string) Optional: None
Output	Successful: Returns a JSON or XML object with Codelist: Codes and descriptions Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getCodelist action with agencyID=BIS and clID=CL_FREQ Map codes to labels Use in query construction

2.7 Get Concept Scheme Retrieval

Action	getConceptScheme
Purpose	Retrieves a specific concept scheme by agency and ID, defining concepts used in data.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) csID: Concept scheme ID (string) Optional: None
Output	Successful: Returns a JSON or XML object with ConceptScheme: Concepts and relationships Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getConceptScheme action with agencyID=BIS and csID=CS_MEASURE Review concepts Use for understanding data semantics

2.8 Get Data Provider Scheme Retrieval

Action	getDataProviderScheme
Purpose	Retrieves a specific data provider scheme by agency and ID, detailing data providers.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) dpsID: Data provider scheme ID (string) Optional: None
Output	Successful: Returns a JSON or XML object with DataProviderScheme: Providers and details Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getDataProviderScheme action with agencyID=BIS and dpsID=DPS_BIS Review providers Use for data sourcing

2.9 Get Dataflows Retrieval

Action	getDataflows
Purpose	Retrieves all dataflows available in the BIS catalog.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON or XML object with Dataflows: Array of dataflow objects Failure: Returns error details (e.g., 500: Internal server error)
Workflow Example	Execute the getDataflows action List all dataflows Use for catalog exploration

2.10 Get Data Structures Retrieval

Action	getDataStructures
Purpose	Retrieves all data structures available in the BIS catalog.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON or XML object with DataStructures: Array of data structure objects Failure: Returns error details (e.g., 500: Internal server error)
Workflow Example	Execute the getDataStructures action Review structures Use for metadata cataloging

2.11 Get Category Schemes Retrieval

Action	getCategorySchemes
Purpose	Retrieves all category schemes available in the BIS catalog.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: None Optional: None
Output	Successful: JSON or XML object with CategorySchemes: Array of category scheme objects Failure: Returns error details (e.g., 500: Internal server error)
Workflow Example	Execute the getCategorySchemes action List schemes Use for categorization

2.12 Get Codelists Retrieval

Action	getCodelists
Purpose	Retrieves all codelists available in the BIS catalog.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: None Optional: None
Output	Successful: JSON or XML object with Codelists: Array of codelist objects Failure: Returns error details (e.g., 500: Internal server error)
Workflow Example	Execute the getCodelists action List codelists Use for code mapping

2.13 Get Concept Schemes Retrieval

Action	getConceptSchemes
Purpose	Retrieves all concept schemes available in the BIS catalog.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: None Optional: None
Output	Successful: JSON or XML object with ConceptSchemes: Array of concept scheme objects Failure: Returns error details (e.g., 500: Internal server error)
Workflow Example	Execute the getConceptSchemes action List schemes Use for concept understanding

2.14 Get Data Provider Schemes Retrieval

Action	getDataProviderSchemes
Purpose	Retrieves all data provider schemes available in the BIS catalog.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: None Optional: None
Output	Successful: JSON or XML object with DataProviderSchemes: Array of data provider scheme objects Failure: Returns error details (e.g., 500: Internal server error)
Workflow Example	Execute the getDataProviderSchemes action List schemes Use for provider mapping

2.15 Get Dataflows By Agency Retrieval

Action	getDataflowsByAgency
Purpose	Retrieves dataflows maintained by a specific agency.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) Optional: None
Output	Successful: JSON or XML object with Dataflows: Array of dataflow objects for the agency Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getDataflowsByAgency action with agencyID=BIS List BIS dataflows Use for agency-specific exploration

2.16 Get Data Structures By Agency Retrieval

Action	getDataStructuresByAgency
Purpose	Retrieves data structures maintained by a specific agency.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) Optional: None
Output	Successful: JSON or XML object with DataStructures: Array of data structure objects for the agency Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getDataStructuresByAgency action with agencyID=BIS Review BIS structures Use for agency-specific metadata

2.17 Get Category Schemes By Agency Retrieval

Action	getCategorySchemesByAgency
Purpose	Retrieves category schemes maintained by a specific agency.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) Optional: None
Output	Successful: JSON or XML object with CategorySchemes: Array of category scheme objects for the agency Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getCategorySchemesByAgency action with agencyID=BIS List BIS category schemes Use for categorization by agency

2.18 Get Codelists By Agency Retrieval

Action	getCodelistsByAgency
Purpose	Retrieves codelists maintained by a specific agency.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_BIS_BASE_URL environment variable.
Parameters	Required: agencyID: Agency ID (string, e.g., BIS) Optional: None
Output	Successful: JSON or XML object with Codelists: Array of codelist objects for the agency Failure: Returns error details (e.g., 404: Not found)
Workflow Example	Execute the getCodelistsByAgency action with agencyID=BIS List BIS codelists Use for code mapping by agency

Example Workflow

Example Workflow: Economic Data Analysis

Retrieve Dataflows	Use the getDataflows action to fetch all dataflows. Identify target dataflows (e.g., BIS,CC,1.0).
Query Data Structure	Execute the getDataStructure action with agencyID=BIS and dsID=DSD_CC to fetch structure. Process the response to understand dimensions and codes.
Fetch Data	Use the getData action with flow=BIS,CC,1.0 and key=all to retrieve credit data. Integrate the data into an analytics dashboard.
Check Availability	Use the getDataAvailability action to confirm data for specific components. Ensure query feasibility for historical analysis.

This workflow enables applications to provide users with accurate statistical data and metadata, enhancing economic analysis, policy development, and data-driven decision-making.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to Wired for Banking