Documentation

Complete guides, API reference, and technical documentation for Quotelyst

Quick Start

Get up and running in minutes

API Reference

Complete API documentation

Integrations

Connect with your tools

Security

Security best practices

Browse Documentation

Getting Started

Quick Start Guide

Get up and running in 5 minutes

5 min

Account Setup

Configure your account and preferences

3 min

First Quote

Create your first professional quote

7 min

Dashboard Overview

Navigate the main dashboard

4 min

API Reference

Authentication

API keys and authentication methods

6 min

Quotes API

Create, read, update, and delete quotes

12 min

Customers API

Manage customer data and relationships

10 min

Webhooks

Real-time notifications and events

8 min

Integrations

CRM Integration

Connect with Salesforce, HubSpot, and more

15 min

Email Setup

Configure email notifications and templates

8 min

Payment Gateways

Stripe, PayPal, and other payment methods

10 min

Webhook Configuration

Set up real-time data synchronization

12 min

Advanced Features

Custom Templates

Create and manage quote templates

20 min

Automation Rules

Set up automated workflows

15 min

Analytics & Reporting

Advanced reporting and insights

12 min

Team Management

User roles and permissions

8 min

Code Examples

Authentication Example

// Initialize the Quotelyst API client
const quotelyst = new QuotelystAPI({
  apiKey: 'your-api-key-here',
  environment: 'production' // or 'sandbox'
});

// Test the connection
const testConnection = async () => {
  try {
    const response = await quotelyst.auth.verify();
    console.log('API connection successful:', response);
  } catch (error) {
    console.error('API connection failed:', error);
  }
};

Create Quote Example

// Create a new quote
const createQuote = async () => {
  const quoteData = {
    customer: {
      name: 'Acme Corporation',
      email: 'contact@acme.com',
      company: 'Acme Corporation'
    },
    items: [
      {
        name: 'Professional Services',
        description: 'Custom development work',
        quantity: 40,
        unitPrice: 150.00
      }
    ],
    settings: {
      currency: 'USD',
      taxRate: 0.08,
      dueDate: '2024-02-15'
    }
  };

  try {
    const quote = await quotelyst.quotes.create(quoteData);
    console.log('Quote created:', quote.id);
    return quote;
  } catch (error) {
    console.error('Failed to create quote:', error);
  }
};

Webhook Handler Example

// Express.js webhook handler
const express = require('express');
const app = express();

app.use(express.json());

app.post('/webhook/quotelyst', (req, res) => {
  const { event, data } = req.body;
  
  switch (event) {
    case 'quote.created':
      console.log('New quote created:', data.quote.id);
      // Handle new quote
      break;
      
    case 'quote.accepted':
      console.log('Quote accepted:', data.quote.id);
      // Create order or send confirmation
      break;
      
    case 'quote.declined':
      console.log('Quote declined:', data.quote.id);
      // Follow up with customer
      break;
      
    default:
      console.log('Unknown event:', event);
  }
  
  res.status(200).send('OK');
});

API Status & Limits

API Status

All systems operational

99.9% uptime in the last 30 days

Rate Limits

1,000 requests per hour

Per API key

Security

HTTPS only

API keys required

SDKs & Tools

JavaScript SDK

Official Node.js and browser SDK

Python SDK

Python library for server-side integration

Postman Collection

Ready-to-use API collection

OpenAPI Spec

Machine-readable API specification

Need Help?

Can't find what you're looking for? Our developer support team is here to help.