API Documentation

Build with Nocean API

Powerful APIs to integrate Nocean into your workflow. Create portals, track analytics, and automate your sales process programmatically.

Everything You Need to Build

Our API provides all the tools you need to create powerful integrations

RESTful API

Clean, predictable RESTful endpoints with comprehensive JSON responses. Easy to understand and implement.

Secure Authentication

Industry-standard OAuth 2.0 and API key authentication. Keep your data safe and secure.

Webhooks

Real-time webhooks for portal events. Get instant notifications when important actions occur.

Detailed Documentation

Comprehensive guides, code examples, and interactive API reference to get you started quickly.

Quick Start

Get started with the Nocean API in minutes. Our SDKs support JavaScript/TypeScript, Python, and Ruby.

Get Your API Key

Install the SDK

Use npm, pip, or gem to install the Nocean SDK

Make Your First API Call

Create a portal, track analytics, or manage templates

example.js

// Initialize Nocean API Client
import { NoceanAPI } from '@nocean/api';

const nocean = new NoceanAPI({
  apiKey: 'your_api_key_here'
});

// Create a new portal
const portal = await nocean.portals.create({
  title: 'Client Proposal',
  template: 'sales-proposal',
  recipient: {
    email: 'client@example.com',
    name: 'John Doe'
  }
});

console.log('Portal created:', portal.url);