Zendit SDK for Node.js

The Zendit SDK for Node.js allows developers to easily interact with the Zendit API using TypeScript. The SDK provides convenient methods for making API requests and handling responses, abstracting away the details of HTTP requests and JSON parsing.

Documentation

The documentation for the Zendit API can be found here.

Versions

Zendit-node uses Semantic Versioning for all changes.

Supported Node.js Versions

This library has been tested using the following Node.js implementations:

• Node.js 17.5+
• TypeScript 4.0+

Installation

Add Zendit SDK to your project

Add the Zendit SDK to your NPM dependencies by running the following command:

npm install @zenditplatform/zendit-sdk

To use the Zendit SDK in your project, provide your API key instead of the placeholder YOUR_KEY_HERE. You can find your key in the dashboard

import { ZenditApi } from "@zenditplatform/zendit-sdk";

const zenditAPI = new ZenditApi("YOUR_KEY_HERE")

Example

Create a new project

To help you get started quickly, we've set up an example app for you.

To get started, copy the example app to your own directory. Then, run the following command:

npm install

Configuration

To configure the example app, you'll need to set the ZENDIT_API_KEY environment variable. You can find this key on the dashboard.

To set this variable, you can use a .env file located in the root folder of the example application. Paste your API key instead of placeholder YOUR_KEY_HERE:

ZENDIT_API_KEY=YOUR_KEY_HERE

Run example

To run an example of the Zendit SDK for Node.js, execute the following command:

npm run example

SDK Guide

For additional documentation checkout the SDK Guide

Getting help

If you need assistance with installing or using the library, please refer to the Developers site first. If you cannot find the answer to your question, you can contact support.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

Contributing

Bug fixes, docs, and library improvements are always welcome. Please refer to our Contributing Guide for detailed information on how you can contribute.

You are welcome to suggest changes and submit PRs illustrating the changes. You can find more info about this in the Contributing Guide.

If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial.