diff --git a/src/docs.json b/src/docs.json index dc4de9b0..de423163 100644 --- a/src/docs.json +++ b/src/docs.json @@ -128,6 +128,7 @@ "provider-guides/dynamicsBusinessCentral", "provider-guides/dynamicsCRM", "provider-guides/emailBison", + "provider-guides/fastSpring", "provider-guides/fathom", "provider-guides/figma", "provider-guides/fireflies", diff --git a/src/generate-docs.ts b/src/generate-docs.ts index 1079fb60..f4ff67b4 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -359,6 +359,7 @@ const baseConfig = { "provider-guides/dynamicsBusinessCentral", "provider-guides/dynamicsCRM", "provider-guides/emailBison", + "provider-guides/fastSpring", "provider-guides/fathom", "provider-guides/figma", "provider-guides/fireflies", diff --git a/src/images/provider-guides/fastSpring/fastSpring-api-credentials.png b/src/images/provider-guides/fastSpring/fastSpring-api-credentials.png new file mode 100644 index 00000000..7ae1e361 Binary files /dev/null and b/src/images/provider-guides/fastSpring/fastSpring-api-credentials.png differ diff --git a/src/images/provider-guides/fastSpring/fastSpring-api-tab.png b/src/images/provider-guides/fastSpring/fastSpring-api-tab.png new file mode 100644 index 00000000..d62df772 Binary files /dev/null and b/src/images/provider-guides/fastSpring/fastSpring-api-tab.png differ diff --git a/src/images/provider-guides/fastSpring/fastSpring-developer-tools.png b/src/images/provider-guides/fastSpring/fastSpring-developer-tools.png new file mode 100644 index 00000000..de4b12a4 Binary files /dev/null and b/src/images/provider-guides/fastSpring/fastSpring-developer-tools.png differ diff --git a/src/provider-guides/fastSpring.mdx b/src/provider-guides/fastSpring.mdx new file mode 100644 index 00000000..fb0db62d --- /dev/null +++ b/src/provider-guides/fastSpring.mdx @@ -0,0 +1,89 @@ +--- +title: "FastSpring" +--- + +## What's supported + +### Supported actions + +This connector supports: + +- [Read Actions](/read-actions), including full historic backfill and incremental read. +- [Write Actions](/write-actions) (create/update). +- [Proxy Actions](/proxy-actions), using the base URL `https://api.fastspring.com`. +- Subscribe Actions are not currently supported. + +### Supported objects + +export const Check = () => ✅ +export const Cross = () => 🚫 + +
+ + + + + + + + + + + + + + + + + +
ObjectReadWriteSubscribe
accounts
orders
products
subscriptions
events-processed
events-unprocessed
+
+ +### Notes and limitations + +- **Write support**: `orders` and `subscriptions` support **update** only. All other writable objects (`accounts`, `products`) support create and update. Single-record operations only (no bulk write). +- **Commands**: FastSpring also exposes **command**-style operations (for example subscription cancel or product deactivation). These endpoints don't map cleanly to the Read/Write model. [Write Actions](/write-actions) can still invoke those commands; for an explicit call to a command endpoint, see the [FastSpring API reference](https://developer.fastspring.com/reference/getting-started-with-your-api) and use [Proxy Actions](/proxy-actions). + +### Example integration + +To define an integration for FastSpring, use a manifest file (`amp.yaml`). For a complete example, visit our [samples repo on GitHub](https://github.com/amp-labs/samples/blob/main/fastSpring/amp.yaml). + +## Before you get started + +To integrate **FastSpring** with **Ampersand**, you need a [FastSpring](https://fastspring.com/) account and **API credentials** (API username and password) from FastSpring. + +FastSpring documents API access in [Getting started with your API](https://developer.fastspring.com/reference/getting-started-with-your-api), including the base URL, Basic authentication, required headers, and credential generation. + +### Creating FastSpring API credentials + +Per FastSpring’s documentation: + +1. In the FastSpring application, open **Developer Tools**. + + ![FastSpring Developer Tools](/images/provider-guides/fastSpring/fastSpring-developer-tools.png) + +2. Go to **APIs** → **API Credentials**. + + ![FastSpring APIs and API Credentials](/images/provider-guides/fastSpring/fastSpring-api-tab.png) + ![FastSpring APIs and API Credentials](/images/provider-guides/fastSpring/fastSpring-api-credentials.png) + +3. Use **Create** to generate credentials for the first time. FastSpring shows the username and password; the password is available only at creation time—store it securely. + +## Using the connector + +This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) + +To start integrating with FastSpring: + +- Create a manifest file; see [Example integration](#example-integration). +- Deploy it using the [amp CLI](/cli/overview). +- If you are using Read Actions, create a [destination](/destinations). +- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. Your customers enter their FastSpring API username and password when they connect their account. +- Start using the connector: + - If your integration has [Read Actions](/read-actions), scheduled reads will sync data according to your configuration. + - If your integration has [Write Actions](/write-actions), you can call the Write API to create or update supported records. + - If your integration has [Proxy Actions](/proxy-actions) enabled, you can make Proxy API calls to `https://api.fastspring.com`. + +## Upstream API documentation + +- [FastSpring — Getting started with your API](https://developer.fastspring.com/reference/getting-started-with-your-api)