@okapihq/sdk
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

Okapi SDK

Okapi let's you build easily web3 loyalty programs and many more! For more information, visit getokapi.xyz

Features:

  • Get the a wallet data by user
  • Evaluate an objective with user and id
  • Evaluate a reward with user and id
  • Get a token gate status with user and id
  • ... and much more.

Check the official Okapi docs for more details.

Quick start

If you're new to Okapi, check the quickstart guide in the official docs on how to get started with Okapi.

If you're already familiar with Okapi and have your signed up, create tokens, objectives, rewards and token gates, follow along to connect your SDK:

Install Okapi

The easiest way to integrate the Okapi SDK into your JavaScript project is through the npm module.

Install the package via npm:

npm install @okapihq/sdk

or yarn:

yarn add @okapihq/sdk

Import Okapi:

import { okApiClient } from '@okapihq/sdk';

Initialize Okapi

After your dependency is added, you simply need to initialize okapi via the start method:

⚠️ Warning: Make sure to keep your api key private

okApiClient.start('YOUR_API_KEY');

After that you can use any Okapi functionalities as described in our extensive docs.

Star us ⭐️

If this JS SDK helps you build your dapps faster - please star this project, every star makes us very happy!

Need help?

If you need help with setting up Okapi or have any other questions - don't hesitate to write us on Discord and we will check asap.

Community

Readme

Keywords

Package Sidebar

Install

npm i @okapihq/sdk

Weekly Downloads

2

Version

1.0.4

License

ISC

Unpacked Size

7.95 kB

Total Files

8

Last publish

Collaborators

  • getokapi