3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
# Medusa JS Client
|
|
|
|
The [Medusa JS Client](https://www.npmjs.com/package/@medusajs/medusa-js) provides easy access to the Medusa API from a client written in Typescript. This reference guides you to learn what methods the client has and how you can use them.
|
|
|
|
This client can be use as an alternative to directly interacting with the [REST APIs](https://docs.medusajs.com/api/store).
|
|
|
|
## Installation
|
|
|
|
To install the Medusa JS Client run the following command:
|
|
|
|
```bash npm2yarn
|
|
npm install @medusajs/medusa-js
|
|
```
|
|
|
|
## Usage
|
|
|
|
Import Medusa as a default import and initiate it:
|
|
|
|
```js
|
|
import Medusa from "@medusajs/medusa-js"
|
|
|
|
const medusa = new Medusa()
|
|
```
|
|
|
|
## How to Use this Reference
|
|
|
|
You'll find in the sidebar of this reference names of different resources. These resources are properties in the medusa instance you initialize and you can access them directly using the instance. Then, you'll be able to access the methods or nested resources within those resources.
|
|
|
|
For example, to create a new customer you can access the [create](/references/js-client/classes/CustomerResource#create) method under the [customers](/references/js-client/classes/CustomerResource) property of your client:
|
|
|
|
```js
|
|
import Medusa from "@medusajs/medusa-js"
|
|
|
|
const medusa = new Medusa()
|
|
|
|
//use method
|
|
medusa.customers.create({
|
|
//data
|
|
})
|
|
```
|
|
|
|
The `customers` resource also has another resource `addresses` nested inside it with its own method that you can access similarly:
|
|
|
|
```js
|
|
medusa.customers.addresses.addAddress({
|
|
//data
|
|
})
|
|
```
|
|
|
|
## Authentication
|
|
|
|
Authentication can be achieved in two ways using the `medusa-js` client: either by utilizing API keys or by using cookie based authentication. Each method has its own unique use case.
|
|
|
|
### Using API keys
|
|
|
|
API keys can only be used for admin functionality in Medusa since only users of the admin system have API keys. Refer to the [Configuration](#configuration) section to learn how to add the API key to requests.
|
|
|
|
### Using cookies
|
|
|
|
Authentication using cookies is done automatically by Axios when authenticating using the [auth](/references/js-client/classes/AuthResource) endpoints. After authentication, all subsequent calls will be authenticated.
|
|
|
|
## Configuration
|
|
|
|
### Initialize with config object
|
|
|
|
The package can be initialized with several options:
|
|
|
|
```js
|
|
const medusa = new Medusa({
|
|
maxRetries: 3,
|
|
baseUrl: "https://api.example.com",
|
|
})
|
|
```
|
|
|
|
| Option | Default | Description |
|
|
| ------------ | ------------------------- | --------------------------------------------------------- |
|
|
| `maxRetries` | `0` | The amount of times a request is retried. |
|
|
| `baseUrl` | `'http://localhost:9000'` | The url to which requests are made to. |
|
|
| `apiKey` | `''` | Optional api key used for authenticating admin requests . | |