lz-api-client v0.18.3

lz-api-client

Client SDK for LayerZ API

• Description
• Installation
• Usage
  • Initialization
  • Services
  • Example Usage
  • Making Requests
• License

Description

lz-api-client is a client SDK for interacting with the LayerZ API. It provides a set of tools and functions to easily integrate LayerZ API into your applications.

Installation

You can install the package using npm:

npm install lz-api-client

Usage

Here's an example of how to use the lz-api-client:

Initialization

First, you need to initialize the client with the required parameters:

import { Client } from 'lz-api-client';

const client = new Client({
  apiURL: 'https://api.layerz.com',
  referrerPolicy: 'no-referrer'
});

Services

The client provides several services to interact with different parts of the API:

• account
• campaign
• journey
• layer
• user

Example Usage

const campaigns = await client.campaign.get();
console.log(campaigns);

Making Requests

You can also make custom GET requests using the get method:

const response = await client.get('/path/to/resource', { param1: 'value1' });
console.log(response);

Handling errors

Every service method throws errors if something goes wrong. The errors that could be thrown are:

• ClientError Means that something is wrong with the client request, for example invalid parameters. This error type encapsulate all HTTP errors from 400 to 499. The error includes these fields:

  • status (equal to fail)
  • message
  • data (object like, where keys are the invalid params and values the error message)

• ServerError Means that something is wrong in the server, for example server is not available. This error type encapsulate all HTTP errors from 500. The error includes these fields:

  • status equal to error
  • message

License

This project is licensed under the MIT License. See the LICENSE file for details.