@mymoid/api

MYMOID JavaScript API SDK

npm bundle size

Welcome to the MYMOID JavaScript API SDK! 🎉 This library provides an easy-to-use interface for interacting with the MYMOID REST API using JavaScript or TypeScript.

Documentation

For detailed instructions on getting started with the MYMOID JavaScript API SDK, please refer to our developer's portal getting started.
For a complete reference of the API, please refer to our API reference.
For a complete reference of the SDK, please refer to our SDK Documentation.

Getting Started

Installation

To install the SDK in your project, run the following npm command:

npm install @mymoid/api

SDK Basic Setup

Create a MymoidApi instance before initializing your application. You should only have one instance of the client.

[!IMPORTANT] Ensure that you have an API Key and an Organization ID, as these are required for setup. If you don't have them yet, please refer to our initial setup.

Using Environment Variables (Recommended)

Set the following environment variables in your project:

MYMOID_BASE_URL=https://apis.san.mymoid.com
MYMOID_API_KEY=*********************
MYMOID_ORGANIZATION_ID=******************

Passing `Options` to `MymoidApi`

Alternatively, you can pass options directly to MymoidApi instance:

import { MymoidApi } from '@mymoid/api'

const api = await MymoidApi({
  baseUrl: '{MYMOID_BASE_URL}',
  apiKey: '{MYMOID_API_KEY}',
  organizationId: '{MYMOID_ORGANIZATION_ID}'
})