Skip to main content

Developer Guide Overview

This section contains comprehensive technical documentation for developers working with or integrating the SBM CRM Platform.

Documentation Structure​

Architecture​

Learn about the system architecture, design patterns, technology stack, and how components interact.

  • Architecture Overview - System components, microservices architecture, data flow, and scalability considerations

Authentication​

Understand authentication and authorization mechanisms for API access.

API Integration​

Comprehensive guide for integrating with the SBM CRM Platform APIs.

Webhooks​

Set up and handle webhooks for real-time event notifications.

  • Webhooks Guide - Event types, webhook setup, security, signature verification, and best practices

Quick Start​

1. Get API Credentials​

  1. Log in to the Admin Web App
  2. Navigate to Settings → API Keys
  3. Create a new API key
  4. Copy and securely store your API key

2. Make Your First API Call​

const response = await fetch('https://api.sbmcrm.example.com/v1/customers', {
  headers: {
    'Authorization': `Bearer YOUR_API_KEY`,
    'Content-Type': 'application/json'
  }
});

const customers = await response.json();

3. Set Up Webhooks​

// Register webhook endpoint
const webhook = await fetch('https://api.sbmcrm.example.com/v1/webhooks', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer YOUR_API_KEY`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://your-app.com/webhooks/sbmcrm',
    events: ['customer.created', 'points.earned']
  })
});

Prerequisites​

Before diving into the developer guides, ensure you have:

  • Basic understanding of REST APIs - Familiarity with HTTP methods, status codes, and JSON
  • Knowledge of your preferred programming language - JavaScript, Python, PHP, or others
  • API credentials - API key or OAuth credentials from the Admin Web App
  • HTTPS endpoint - For webhook integration (use tools like ngrok for local testing)

API Base URL​

  • Production: https://api.sbmcrm.example.com/v1
  • Sandbox: https://api-sandbox.sbmcrm.example.com/v1

SDKs and Libraries​

Official SDKs are available for:

  • JavaScript/Node.js - @sbmcrm/sdk-js
  • Python - sbmcrm-python
  • PHP - sbmcrm-php

Getting Help​

  • API Documentation - See API Reference for detailed endpoint documentation
  • Code Examples - Check Code Examples for practical integration examples
  • Support - Contact support for integration assistance

Next Steps​

  1. Read the Architecture Overview to understand the system design
  2. Set up Authentication for your integration
  3. Review API Integration Guide for API usage
  4. Explore Code Examples for implementation patterns
  5. Set up Webhooks for real-time event notifications