API Keys

Welcome to Spinwheel!

We are your partner for embedded debt solutions!

To simplify your experience and integration, we have created a number of guides and recipes for key use cases, and are continually adding to our developer portal with new features and capabilities.

To start off, there are a couple of key sections to highlight around the Spinwheel platform.

Retrieve Your API Keys

Accessing the Spinwheel platform requires a developer account with credentials. To get your Spinwheel secret key:

  1. Navigate to https://developer.spinwheel.io
  2. Sign up either SSO or a magic link to your email. Note: Please remember which method you used because if you use the other method when you return it will create a new account.
  3. At the bottom of the key management section under the heading Sandbox API Keys you will find your new secret key, which can be used to access all Spinwheel sandbox services.

📘

Production Access

If you are ready to proceed with a production integration, please contact the Spinwheel representative you have been working with.

Endpoints

All of our endpoints and functionality are accessible via Sandbox, and align to our Production functionality.

The following endpoints are the base URLs for your use with the APIs:

Secure Endpoints

There are specific functionalities that require an additional layer of security. For those use cases the following URLs are required to be used. These will be called out in the documentation if necessary, but they are listed here for your convenience:

Connecting a User

Once you have retrieved your secret key, you can start connecting users. User connections can be made either via API or by serving your user one of our Connect Drop-in Modules (DIM).


📘

Important Note

Once a user is connected to the Spinwheel platform, their userId is the unique key used for accessing most of our APIs and Drop-in Modules.

Glossary

Our guides make use of some terminology that you may be unfamiliar with. We suggest taking a look at our glossary before getting started!

To learn more about our debt APIs and 1-click solutions, visit spinwheel.io.

Updated 2 months ago