Overview

The FastSpring API is a REST API that you can use to pass and retrieve information between your store and website. The API will return information in a JSON response, using secure HTTPS communication protocols.

The primary communication methods include the following:

• GET: Request data from your store.
• POST: Send data to your store.
• DELETE: Remove data from your store.

FastSpring requires a TLS 1.2 (or later) encryption for each call and a User-Agent header in each request.

Credentials

To start using the API, authenticate your API credentials in the FastSpring App. Store the credentials in a secure place for future reference; you cannot view the password after the initial session.

1. In the FastSpring App, navigate to Developer Tools >APIs> API Credentials.
2. Click Create. FastSpring will automatically generate your username and password.
3. Securely store the credentials for future reference.
   If you reset your credentials, update each stored procedure that relies on API access to prevent failed requests.

👍

Use Base64 to encode your username and password in the headers.

Data Types

• String columns: VARCHAR 255
• Encoding: UTF-8
• Numeric values: 2dp precision; this applies to price and discount values.

Rate Limits

To maintain a responsive user experience, FastSpring may impose request rate limits on API calls that originate from individual accounts. This results in an HTTP 404 response code. To avoid rate limits, consider making batch requests.

API Log Activity

View API History

You can view the history of your configured FastSpring APIs in the API Log. Navigate to Developer Tools > APIs > Log

The API Log displays rich information for each API you’ve configured in FastSpring, including:

• Request Date: API request date and time (in UTC)
• Status: The status of the API
• HTTP method: There are four methods available:
  • GET
  • POST
  • DELETE
  • PUT
• Path: The first thirty characters of the API path
• API Latency: The response time (in seconds) between when an API request is received by FastSpring and when the response is delivered to you

You will also be able to view detailed information about each API by clicking anywhere on that line item, including the API’s request header and body, and the response header and body.

The Log has filtering capabilities to allow you to view a subset of APIs that you’re interested in. You can filter by request date/time, status, HTTP method, path (condensed to the resource name), and API latency.

NOTE: In order for your log to display, you will need to set up your API credentials (see instructions above). Only APIs from the last 60 days will appear in the log.