Matador.ai Node.js SDK

Version 0.5.2

Introduction

The Matador Node.js SDK gives you an easy and reliable way to interact with the Matador Public API’s. This documentation provides a description of all the resources available in this NPM package.

Full Documentation

Here is a link to the complete package documentation on Notion. https://matadordev.notion.site/Matador-Node-js-SDK-226bb6a4a7aa4c82b5cc3f74ceb4833c

Getting started

Installation

Use the package manager of your choice.

yarn add matadorai

API Key

This package requires an API key.

The Matador Client

The package provides a core object which takes care of all the background API communication. The MatadorClient object will be more than enough to perform most operations.

On initialization, these arguments should to the constructor:

1. apiKey required to perform all operations

💡 More optional configuration params will be available in future releases

Here is an example:

const {MatadorClient} = require("matadorai");

const matador = new MatadorClient(YOUR_API_KEY);

Find Dealer API

In case you have a multi-location API key, you need to create a specific key for the location you want to perform the operation on.

const {MatadorClient} = require("matadorai");

const locationAPIKey = MatadorClient.findDealer(YOU_API_KEY, locationId);

const matador = new MatadorClient(locationAPIKey);