API reference
Every endpoint and webhook event of the Shyni API, generated from openapi.yaml.
Base URL: https://api.shyni.io/api/v1 (production). Staging is https://api.shyni.dev/api/v1.
Every request carries a key as a bearer token: Authorization: Bearer <key>. See API keys for key types and scopes.
Download the full spec, openapi.yaml, and import it into Postman, Insomnia or a client generator.
Endpoints
- Account – check that your key works
- Orders – list, create and manage orders, their work and money
- Customers – a business's customers: contacts, subjects (a dog, a car), notes and order counts
- Booking links – prepare a booking for a customer as a link
- Reviews – reply to and report reviews, ask for one
- Availability – bookable start times, calendar, opening hours, blocks and day rules
- Catalog – services, groups and questions, packages, places, discount codes, publishing
- Storefront – content, layout, look and photos of the studio page
- Studio – basic info and settings
- Gift vouchers – sell, read, refund, resend
- Businesses – create, list, change and archive the headless businesses of an organization
- Studios – found studios for clients and hand them over to their owners
- Organization webhooks – one webhook endpoint for the events of all businesses
Writes need a :write scope and an Idempotency-Key; catalog and studio page edits wait in a draft until you publish. See Writing through the API.
Webhook events
Shyni POSTs signed events to your endpoint, for example order.created. Every event, and the webhook.test ping you can send from the admin, is listed under Webhooks in the sidebar; setup and signature verification are in the webhooks guide.