API Credentials
When you register for your Spreedly Organization, you will receive an organization key.. These credentials do not enable you to transact on the API, but will allow you to create the Spreedly environments that you will transact in.
Now that you have a Spreedly Organization, you will want to create your API credentials. At Spreedly, these credentials are the environment key and single-environment access secret.
Environments
Your payment data at Spreedly is organized in environments. When you create an environment in your Organization, you will receive an environment key to represent that environment. You can also provide a name for that environment (e.g. “Testing” or “Production”).
Your environments are not restricted to only one choice of test traffic or production traffic, but we recommend that you create at least two environments separately for these purposes. (You may even simply call these “Testing” and “Production”.) This way, you can separate your test data from your production data more easily for reporting purposes.
You can create additional environments directly from your dashboard in app.spreedly.com. After logging in, click on the Environment tab at the top of the side menu bar, and select “Create new environment”. From here, simply enter a name for your environment, select a “Payment method submission” option, and select “Save changes” to create the environment.
Access Secrets
Now that you’ve created an environment, you’ll need to create an access secret.
There are two kinds of access secrets: an “organization” and “single-environment” access secret. An “organization” access secret, like the one you created when you registered for your Spreedly account, can be used to authenticate any API call in your Organization. While this has its uses, we strongly recommend creating a “single-environment” access secret for each of the environments that you create at Spreedly; this enhances security and ensures that you are only authenticating API calls to the intended environment.
To create a single-environment access secret in app.spreedly.com, use the Environment tab at the top of the side bar menu, navigate to “Access secrets”, and then select the “Add access secret” button. Please note that you will need to copy this access secret to store in a secure manner, as it will no longer be viewable after you navigate away from the page.
Now that you have an environment key and an access secret, you can begin authenticating API requests. Spreedly uses HTTP Basic Authorization for API requests.
Other Credentials
While you now have the credentials you’ll need to access Spreedly, you may also need credentials to send payment data to another party, like a gateway processor, through Spreedly. If you do not already have your sandbox and production credentials at your connections, we encourage you to obtain those as soon as you can. You’ll need those credentials to interact with those endpoints. Please reach out to those parties directly to acquire your credentials.
Adding Users
You may want to add users to your Organization to give them access to the Spreedly app. You can add new users to your Organization by selecting the name of your Organization at the bottom of the side menu bar, choosing “Organization users”, and selecting the “Add user” button on the following page.
You have the ability to configure Role-Based Access Controls for users when you add them to your Organization. This feature aims to increase security for your Organization’s data, creates a separation of duties for users, and fosters a more user-friendly experience for those that are focused on either the business or technical side of the use case by limiting the scope of their access.
You have completed Module 1 if:
-
I have an environment key
-
-