Gumroad-api-tester NPM

Get Started

Documentation

Overview

Gumroad is a platform that allows you to sell digital products such as books, memberships, courses, and more.

Using this tool, you can test out the Gumroad API using your access token. This tool can also be helpful if you need to make changes not supported via the website, such as adding resource subscriptions.

All v2 endpoints are available for quick selection, or you can manually enter things if you'd like. Some parameters are optional—be sure to reference the API docs when in doubt.

When retrieving products, buy links are shown so that you can test product purchases right from within this testing tool.

Try the GET: /user endpoint for a quick test of your access token.

This project is open sourced on GitHub under the MIT License.

🎉 Happy selling!

→ Get started here ←

Features include:

🌀 Quickly and easily test calls to the Gumroad API
- Plug in your access token, choose your desired endpoint, and go!
🧬 Structured and raw responses
- View responses as an interactive tree or as raw text
📝 Easy query and URL param editing
- Easily edit your endpoint params before sending

Donate

If this project helped you, please consider buying me a coffee or sponsoring me. Your support is much appreciated!

Installation

npm i gumroad-api-tester

Usage

Via Website

Go here: Gumroad API Tester

Via `npm`

If you want to use the widget yourself, you can install this package via npm and use the exported GumroadAPIWidget.

import { GumroadAPIWidget } from 'gumroad-api-tester';

<GumroadAPIWidget />

Note: The API widget depends on Bootstrap 5 via react-bootstrap. You must import the Bootstrap styles yourself. For additional styling, I am using the Zephyr swatch from Bootswatch.

TypeScript

Type definitions have been included for TypeScript support.

Icon Attribution

Favicon by Twemoji.

Contributing

Open source software is awesome and so are you. 😎

Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.

For major changes, open an issue first to discuss what you'd like to change.