Error codes and retry guidance
Explains the list of HTTP status codes and error codes the ReceiptRoller API returns, which cases to retry, and guidance on retry intervals.
Setting the redirect URL
Explains the role of the redirect URI (callback URL) you set in the ReceiptRoller developer portal, the registration rules, using development vs. production environments, and common errors and how to handle them.
SLA, uptime, and the checking procedure during an incident
Explains ReceiptRoller's API uptime targets, how to check the status page, the isolation procedure when an incident occurs, and the flow for escalating to support.
The basics of requests and responses (JSON)
Explains the request format, required headers, response structure, pagination, filtering, and date/time format rules of the ReceiptRoller API.
Creating a new app
Explains the concrete steps to register a new app (OAuth client) in the ReceiptRoller developer portal. Covers the input fields, validation, the post-creation credentials display, and common errors.
Representative API examples
Introduces, as curl commands, examples of calling the representative ReceiptRoller API endpoints (retrieving receipts, listing stores, creating products, registering Webhooks).
Endpoints and versioning
Explains the base URL of the ReceiptRoller API, the versioning policy, the deprecation-notice flow, and how to check the current version.
What is application registration
Explains the concept of ReceiptRoller application registration. Registering an app as an OAuth client issues a client ID, secret, and redirect URI, letting you start API and Webhook integrations.
Rate limiting and throttling
Explains the unit of rate limiting for the ReceiptRoller API, the per-plan limits, how to read the response headers, and implementation patterns to avoid hitting 429.
What You Can Do with the Developer Portal
An overview of what the ReceiptRoller developer portal lets you do. Combine data retrieval and operations via the REST API with real-time event delivery via Webhooks to connect store and user data from external systems.
Monitoring and handling failures
Explains how to read the ReceiptRoller Webhook delivery history, the metrics to monitor and how to design alerts, redelivering dead letters, and common failure patterns and recovery procedures.
Webhook overview
Explains the main event types delivered by ReceiptRoller Webhooks, why to use Webhooks instead of polling, the delivery format (HTTPS POST + JSON), and how to think about delivery guarantees.
Signature verification and security
Explains how ReceiptRoller Webhook HMAC-SHA256 signature verification works, sample verification code (Node.js / Python / C#), replay-attack countermeasures, and how to manage secrets safely.
SNS Webhook bypass (forwarding Webhooks from external SNS such as LINE)
Explains the mechanism, setup, signature handling, and cautions of the "SNS Webhook bypass" feature, which forwards Webhooks ReceiptRoller receives from SNS platforms such as LINE to a developer app, with the store's consent.
API Authentication Guide
Explains how to authenticate with the ReceiptRoller API using the OAuth 2.0 authorization code flow.