Open Guestbook API Documentation

Key Functionality

Modular and extensible architecture with enterprise-grade security built-in

Secure Data Flow

Data is encrypted at rest and in transit with FIPS 140-2 compliant AES-256-GCM encryption

Role-Based APIs

Fine-grained access control with configurable permissions and ephemeral API tokens

Flexible Endpoints

RESTful API design with pagination, filtering, sorting and metadata headers

Getting Started

All endpoints require authentication with JWT tokens. Here's how to initialize your client

JavaScript SDK


const client = new OpenGuestbookClient({
    apiKey: 'YOUR_API_KEY',
    apiUrl: 'https://api.openguestbook.tech',
    version: '2025-08-01'
});

// Create entry
const newEntry = await client.entries.create({
    author: 'Jane Doe',
    message: 'Great experience!'
});

cURL Example


curl -X POST 'https://api.openguestbook.tech/v1/entries' \\
  -H 'Authorization: Bearer YOUR_API_KEY' \\
  -H 'Content-Type: application/json' \\
  -d '{ "message": "My new entry!" }'

Authentication

We support JWT bearer tokens for secure authentication and rate limiting. Rate limits reset every 24 hours

Token Authentication

🔐

Bearer Tokens

Use Authorization header with JWT tokens. Valid for 24 hours

🔄

Token Rotation

Tokens refresh every 24 hours or on demand

🚫

Rate Limits

1000 requests/minute by default with configurable tiers

Authentication Headers


Authorization: Bearer {{token}}

Content-Type: application/json

X-OpenGuestbook-Request-Id: optional

All endpoints require the Authorization header with a valid JWT token. Tokens must be prefixed with 'Bearer'

For rate limit visibility, include the optional X-OpenGuestbook-Request-Id header on every request

Version Notes

Our current API is in version 2025-08-01 with full backwards compatibility for legacy endpoints

Endpoint Versioning

Accept header application/vnd.openguestbook+json; version=2025-08-01

Query parameter ?version=2025-08-01

Response Headers

X-API-Version - 2025-08-01

X-API-Committed - true

Core API Endpoints

Our RESTful API provides complete control to create, list, update and delete guestbook entries securely

GET /entries

Retrieve entries with optional filtering by date range, author, and status

POST /entries

Create new guestbook entry with validation and content sanitization

PUT /entries/:id

Update specific entry with atomic operations and optimistic locking

Response Status Codes

Standard HTTP responses with extra headers for rate limiting information

Code	Description	Details
200 OK	Successful request	Request completed successfully
201 Created	Resource created	New resource created successfully
204 No Content	Successful update/delete	Request processed but no content to return
400 Bad Request	Invalid request structure	Request payload is malformed or invalid
401 Unauthorized	Missing or invalid authentication	API key is missing, expired, or invalid
429 Too Many Requests	Rate limit exceeded	X-RateLimit-Remaining header shows available requests
500 Internal Error	Server error	Unexpected server issue, contact support

Need to see more examples or have questions? Check out the interactive demo environment

Open Guestbook API Docs