Quick Start

Introduction

The @postiva/client is a simple and easy to use SDK for Postiva API. It provides a set of methods to interact with the API and it's built with Typescript.

Easy to Use: It is designed to be simple and easy to use.
Type Safety: It is built with TypeScript to ensure type safety.
Developer-Friendly: It is designed to be developer-friendly and easy to use.

Setup

Install

npm install @postiva/client

Envrionment Variables

Create a .env file in the root of your project and add the following:

Info

For access to your access key and workspace ID, sign up on our platform. You can create your access key via the panel once you're registered and locate your workspace ID in the account settings.

.env

NEXT_PUBLIC_POSTIVA_API_KEY=your-api-key
NEXT_PUBLIC_WORKSPACE_ID=your-workspace-id

Initialize Client

libs/postiva.ts

import { createClient } from '@postiva/client';
 
export const postivaClient = createClient({
  apiKey: process.env.NEXT_PUBLIC_POSTIVA_API_KEY,
  workspaceId: process.env.NEXT_PUBLIC_WORKSPACE_ID,
});

Parameters

Prop	Type	Default
`apiKey`	`string`	-
`workspaceId`	`string`	-
`options`	`PostivaClientOptions`	-