diff --git a/src/docs.json b/src/docs.json index 9809411d..128ba692 100644 --- a/src/docs.json +++ b/src/docs.json @@ -168,6 +168,7 @@ "provider-guides/jobber", "provider-guides/joinMe", "provider-guides/jotform", + "provider-guides/jump", "provider-guides/justCall", "provider-guides/kaseyaVSAX", "provider-guides/keap", diff --git a/src/generate-docs.ts b/src/generate-docs.ts index ac3f62c0..33058a63 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -400,6 +400,7 @@ const baseConfig = { "provider-guides/jobber", "provider-guides/joinMe", "provider-guides/jotform", + "provider-guides/jump", "provider-guides/justCall", "provider-guides/kaseyaVSAX", "provider-guides/keap", diff --git a/src/images/provider-guides/jump.gif b/src/images/provider-guides/jump.gif new file mode 100644 index 00000000..16056128 Binary files /dev/null and b/src/images/provider-guides/jump.gif differ diff --git a/src/provider-guides/jump.mdx b/src/provider-guides/jump.mdx new file mode 100644 index 00000000..ab93b068 --- /dev/null +++ b/src/provider-guides/jump.mdx @@ -0,0 +1,53 @@ +--- +title: Jump +--- + +## What's supported + +### Supported actions + +This connector supports: + +- [Proxy Actions](/proxy-actions), using the base URL `https://my.jumpapp.com/enterprise/graphql`. + +### Example integration + +To define an integration for Jump, create a manifest file that looks like this: + +```YAML +# amp.yaml +specVersion: 1.0.0 +integrations: + - name: jumpIntegration + displayName: Jump Integration + provider: jump + proxy: + enabled: true +``` + +## Before You Get Started + +To use the Jump connector, you'll need an API Key from your Jump account. Here's how to get it: + +1. Sign in to the [Jump homepage](https://my.jumpapp.com). +2. In the lower-right corner of the homepage, click **Profile & settings**. +3. Click **Account settings**. +4. Navigate to **API**. +5. Click **Create API Key**. +6. Enter a name and select scopes. +7. Save the key, then copy the generated key. + +![Jump API Key](/images/provider-guides/jump.gif) + +For more details, see the [Jump Authentication documentation](https://my.jumpapp.com/enterprise/documentation/authentication). + +## Using the connector + +This connector uses API Key authentication, 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 integrate with Jump: + +- Create a manifest file like the example above. +- Deploy it using the [amp CLI](/cli/overview). +- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their API Key. +- Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the API Key supplied by the customer.