https://github.com/plusauth/plusauth-rest-js
PlusAuth Rest Client for JavaScript applications
https://github.com/plusauth/plusauth-rest-js
plusauth rest-api rest-client typescript typescript-library
Last synced: 6 months ago
JSON representation
PlusAuth Rest Client for JavaScript applications
- Host: GitHub
- URL: https://github.com/plusauth/plusauth-rest-js
- Owner: PlusAuth
- License: mit
- Created: 2020-08-05T10:01:11.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-23T09:28:50.000Z (6 months ago)
- Last Synced: 2025-07-23T11:31:06.840Z (6 months ago)
- Topics: plusauth, rest-api, rest-client, typescript, typescript-library
- Language: TypeScript
- Homepage: https://docs.plusauth.com/api/core
- Size: 5.63 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @plusauth/plusauth-rest-js
Helper library for interacting with PlusAuth REST API intent upon to be used in NodeJS and browser environments.
Table Of Content
1. [Installation](#installation)
2. [Usage](#usage)
3. [Docs](#docs)
4. [Examples](#examples)
# Installation
From PlusAuth CDN:
```html
```
With npm:
```shell script
$ npm install @plusauth/plusauth-rest-js
```
or with yarn
```shell script
$ yarn add @plusauth/plusauth-rest-js
```
# Usage
## CDN Usage
The library will be exposed to global as `PlusAuthRestClient`
Initialize it like following:
```js
const authToken = ''
const plusAuth = PlusAuthRestClient('https://.plusauth.com', { token: authToken })
```
## NPM Usage
```js
import { PlusAuthRestClient } from '@plusauth/plusauth-rest-js'
const authToken = ''
const plusAuth = new PlusAuthRestClient('https://.plusauth.com', { token: authToken })
```
## CommonJS
```js
const { PlusAuthRestClient } = require('@plusauth/plusauth-rest-js')
const authToken = ''
const plusAuth = new PlusAuthRestClient('https://.plusauth.com', { token: authToken })
```
## Replacing Token
Generally you may need to replace PlusAuth REST API token because its lifetime could end.
In this case updating `options.token` or by using the `token` setter
of PlusAuthClient instance will be enough to change used token.
> To generate access token consult [docs](https://docs.plusauth.com/api/core/authorization) or have a look at [example/getAuthToken.js](./example/getAuthToken.js).
The example file also includes an example curl request.
```js
const initialToken = 'INITIAL_TOKEN'
const plusAuth = new PlusAuthRestClient('https://.plusauth.com', { token: initialToken })
plusAuth.users.getAll().then( function (res){
// retrieved with initial token
console.log(res)
})
// or: plusauth.options.token = 'NEW_TOKEN'
plusAuth.token = 'NEW_TOKEN'
plusAuth.users.getAll().then(function (res){
// Retrieved with new token
console.log(res)
})
```
## Custom HTTP Client
You may provide your own http client to the library when you need to have more control over your requests.
```js
const axios = require('axios')
const plusAuth = new PlusAuthRestClient('https://.plusauth.com', {
httpClient: function (url, options) {
options.url = url
options.data = options.body
return axios(options)
}
})
```
# Docs
For API docs visit [here](https://docs.plusauth.com/api/core)