Getting Started

This guide will help you get started with Sesamy's APIs and SDKs.

Prerequisites

Before you begin, you'll need:

1. A Sesamy account
2. API credentials (API key or OAuth client credentials)
3. Basic knowledge of REST APIs and HTTP requests

Quick Start

1. Get Your API Credentials

Contact the Sesamy team to obtain your API credentials. You'll receive:

• API Key: For server-to-server authentication
• Client ID & Secret: For OAuth 2.0 authentication
• Vendor ID: Your unique vendor identifier

2. Choose Your Integration Method

Using SDKs (Recommended)

Install the official SDK for your platform:

JavaScript/TypeScript

npm install @sesamy/client

Python

pip install sesamy-sdk

iOS

# Add to your Podfile
pod 'SesamySDK'

Android

// Add to your build.gradle
implementation 'com.sesamy:sdk:1.0.0'

Using REST APIs Directly

Make HTTP requests to the Sesamy API endpoints:

curl -X GET https://api.sesamy.com/client/v1/profile \
  -H "Authorization: Bearer YOUR_API_KEY"

3. Make Your First API Call

Here's a simple example to fetch a user's profile:

TypeScript

import { SesamyClient } from '@sesamy/client';

const client = new SesamyClient({
  apiKey: 'YOUR_API_KEY',
  vendorId: 'YOUR_VENDOR_ID'
});

const profile = await client.getProfile();
console.log(profile);

Python

from sesamy import SesamyClient

client = SesamyClient(
    api_key='YOUR_API_KEY',
    vendor_id='YOUR_VENDOR_ID'
)

profile = client.get_profile()
print(profile)

cURL

curl -X GET https://api.sesamy.com/client/v1/profile \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Sesamy-Vendor: YOUR_VENDOR_ID"

Next Steps

Now that you've made your first API call, explore these topics:

• Authentication - Learn about different authentication methods
• API Reference - Browse the complete API documentation
• SDKs - Dive deeper into SDK features
• Guides - Follow step-by-step implementation guides

Getting Help

• Documentation: Browse these docs for detailed information
• API Status: Check status.sesamy.com
• Support: Contact support@sesamy.com
• GitHub: Report issues or contribute at github.com/sesamyab