Understand the Sail API's REST conventions, base URL, and where to find each resource.
The Sail API is organized around REST. It has predictable, resource-oriented URLs, accepts JSON request bodies, returns JSON responses, and uses standard HTTP verbs and response codes.
The API is strictly server-to-server. Calls are made from your backend. Anything your end users see and touch happens in a secure, Sail-hosted widget that you embed in your app, not through direct API calls from a client.
Base URL
All API requests are sent to the following base URL. Add the endpoint path to this URL to make a request to a specific resource.
https://live.savewithsail.com/api/v1Setup and integration
The resources below cover authentication, error handling, and event delivery. Start here if you're setting up your first integration.
API keys, scopes, ephemeral user tokens, and the endpoint authorization matrix.
The standard error envelope and the full HTTP status and error code catalog.
The complete event catalog, envelope shape, and signature verification.
Per-endpoint request budgets, rate limit headers, and handling 429 responses.
API resources
Every resource available through the Sail API. Each link takes you to the full endpoint reference for that resource.