A javascript SDK client that interfaces with the Waylay REST API's.
yarn add @waylay/client
or
npm install --save @waylay/client
You can also include the generated umd
file directly into a script tag. This will add a global waylay
function to the window
. You can access this via window.waylay
or just waylay
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<!-- Place script tag at the end of body -->
<!-- to get the latest version: -->
<script src="https://unpkg.com/@waylay/client/dist/waylay.umd.js"></script>
<!-- to get a specific version: -->
<script src="https://unpkg.com/@waylay/client@2.44.0/dist/waylay.umd.js"></script>
</body>
</html>
Create a client, using an apiKey and secret
const Waylay = require('@waylay/client')
const gateway = 'https://api.waylay.io'
const waylay = new Waylay({gateway})
await waylay.authenticate(myApiKey, myApiSecret)
Create a client, with a Waylay jwt token that was acquired elsewhere:
const waylay = new Waylay({gateway, token})
Create a new client, using user login (requires the tenant to be identified by its domain
).
// notice the lowercase waylay
const client = new waylay({gateway, domain: 'myDomain.waylay.io'})
// login example
async function login(user, password){
try {
await client.login(user, password)
} catch(err) {
// error happened while logging in
}
await client.loadSettings()
}
The API documentation for the SDK itself can be found at sdk.waylay.io. It documents how to authenticate and configure the client, and describes the services, resources and operations that are available.
The SDK client wraps the Waylay REST APIs as documented at docs.waylay.io. That documentation describes the request and response messages that you'll encounter when interacting with the SDK.