Files
simple-aircraft-manager-rails/docs/guide/README.md
T
rickyandClaude Opus 5.5 bffdea937c REST API v1: tokens, read endpoints, squawks, webhooks
- Personal tokens (Profile → API tokens) act as their owner; integration
  tokens (Admin → Integrations) reach chosen aircraft and scopes, and their
  writes name the person they're for (SAM-On-Behalf-Of). Tokens are stored
  hashed, shown once, revocable, with last use recorded.
- GET aircraft, components, due list, inspections, ADs, logbook entries and
  squawks; POST/PATCH squawks with external_ref links to the other system.
- Idempotency-Key for safe retries, paging, JSON errors, rate limits.
- Record history keeps the token with each change (in the hashed payload).
- Webhooks (squawk created/updated/resolved, entry signed), HMAC-signed,
  retried, never sent to the server itself; deliveries listed for admins.
- The outbound address check is shared by AirTrail and webhooks; reporting a
  squawk is announced the same way from the form and the API.
- docs/guide/api.md: the API reference.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 19:05:10 -05:00

2.1 KiB

User guide

Simple Aircraft Manager keeps the records and status of a small fleet: hours, squawks, components, the maintenance logbook, inspections, ADs, documents, oil and fuel, weight and balance. It works out whether each aircraft is airworthy from those records. This guide explains how to use it, for everyone who flies, maintains or administers the aircraft.

The same pages are in the app under Help in the menu.

Disclaimer: the app is provided as is, without warranty, and is not FAA-approved. It is up to you to verify that using it is legal and suitable for your operation. See the Disclaimer.

Everyone

Owners and mechanics

Administrators

  • Administration: users, settings, templates, backups and off-site backup to Google Drive, recordkeeping procedures and audits
  • REST API: tokens, endpoints and webhooks, for scripts and other systems such as Redmine
  • Disclaimer: no warranty; verifying legal use is up to you

Installing and hosting the app is covered in the project's main README.