@ibm-cloud/data-virtualization-on-cloud
v0.1.0
Published
IBM Data Virtualization on Cloud Node.js SDK
Downloads
2
Readme
IBM Data Virtualization on Cloud Node.js SDK
A Node.js client library to interact with the IBM Data Virtualization on Cloud APIs.
Disclaimer: this Data Virtualization on cloud SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.
Table of Contents
- Overview
- Prerequisites
- Installation
- Authentication
- Using the SDK
- Questions
- Issues
- Open source @ IBM
- Contributing
- License
Overview
The IBM Data Virtualization on Cloud Node.js SDK allows developers to programmatically interact with the following IBM Cloud services:
Service Name | Import Path --- | --- Data Virtualization on Cloud | @ibm-cloud/data-virtualization-on-cloud/data-virtualization
Prerequisites
- You need an IBM Cloud account.
- A Data Virtualization on Cloud instance.
- An IBM Cloud API key that allows the SDK to access your account.
- Node.js version 12 or above.
Installation
npm install @ibm-cloud/data-virtualization-on-cloud
Authentication
Data Virtualization on Cloud uses token-based Identity and Access Management (IAM) authentication.
With IAM authentication, you supply an API key that is used to generate an access token. Then, the access token is included in each API request to Data Virtualization on Cloud. Access tokens are valid for a limited amount of time and must be regenerated.
Authentication for this SDK is accomplished by using IAM authenticators.
Using the SDK
For general SDK usage information, please see this link
Questions
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
Issues
If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.
Open source @ IBM
Find more open source projects on the IBM Github Page
Contributing
See CONTRIBUTING.
License
This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.