Skip to main content

Documentation

Welcome to the PicBee developer documentation. Learn how to integrate PicBee into your applications, use our API, and build custom solutions for your event photography needs.

Quick Start

Get started with PicBee in three simple steps:

  1. Create a PicBee account and navigate to Settings → API Keys
  2. Generate your API key and keep it secure
  3. Start making API requests using your preferred programming language

API Overview

The PicBee API provides programmatic access to all platform features including event management, photo uploads, album organization, and analytics. Our RESTful API uses JSON for requests and responses.

Authentication

All API requests require authentication using your API key. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limits

API requests are rate-limited to ensure platform stability:

  • Free tier: 100 requests/hour
  • Paid plans: 1000 requests/hour
  • Enterprise: Custom limits

Core Endpoints

Events API

GET, POST, PUT, DELETE

Create, update, and manage events programmatically.

GET /api/events
POST /api/events
PUT /api/events/:id
DELETE /api/events/:id

Albums API

GET, POST, PUT, DELETE

Organize photos into albums within events.

GET /api/events/:eventId/albums
POST /api/events/:eventId/albums
PUT /api/albums/:id
DELETE /api/albums/:id

Photos API

GET, POST, DELETE

Upload and manage photos in your albums.

GET /api/albums/:albumId/photos
POST /api/albums/:albumId/photos
DELETE /api/photos/:id

Analytics API

GET

Access event analytics and engagement metrics.

GET /api/dashboard/analytics?timeRange=30d

Integration Guides

JavaScript/Node.js

Integrate PicBee into your Node.js applications using our official SDK or REST API.

Python

Use PicBee with Python applications for automation and data processing.

Webhooks

Receive real-time notifications for events like photo uploads and album updates.

Example Request

// Create a new event
const
response =
await
fetch(
'https://api.picbee.app/api/events'
, {
  method:
'POST'
,
  headers: {
    
'Authorization'
:
'Bearer YOUR_API_KEY'
,
    
'Content-Type'
:
'application/json'

  },
  body: JSON.stringify({
    name:
'My Wedding'
,
    eventType:
'wedding'
,
    startDate:
'2024-06-15'

  })
});

Resources

  • API Reference: Complete endpoint documentation with parameters and responses
  • Code Examples: Sample code in multiple programming languages
  • SDKs: Official libraries for popular frameworks
  • Changelog: Track API updates and new features
  • Status Page: Monitor API uptime and performance

Support

Need help with integration? Our developer support team is here to assist.
Email: [email protected]
Community: Join our developer community for discussions and updates

API documentation is continuously updated. Check back regularly for new features and improvements.