Getting Started

Welcome to the documentation for our product. Here you’ll find guides and API references to help you start integrating quickly.

Tip: You can use our API Sandbox to test endpoints live!

Installation

Install our SDK using npm or include it directly from our CDN:

npm install our-sdk
<script src="https://cdn.our-website.com/sdk.min.js"></script>

Usage

Initialize the SDK and start using the API right away:

import Client from 'our-sdk';

const client = new Client({ apiKey: 'YOUR_API_KEY' });
client.getUser('1234').then(user => console.log(user));

API Reference

The API Reference provides detailed information about all available endpoints, parameters, and response formats. Use it to integrate our SDK or REST API into your application with confidence.

Updates a user's profile data. 
diff
- "name": "Jane Doe"
+ "name": "Janet Doe"
+ "email": "janet@example.com"

Authentication

All API requests require authentication using your API key. You can find your key in the Developer Dashboard under Account Settings → API Keys.

Keep your API key secret. Do not expose it in public repositories or client-side code. 
curl https://api.our-website.com/v1/users \
  -H "Authorization: Bearer YOUR_API_KEY"