Skip to content

Stripe Query Authentication Guide

This is a step-by-step guide to acquiring a Stripe API key to authorize the Stripe Query component.

Authorizing the Stripe Query component involves four steps:

  1. Obtain an API key from the Stripe developer portal.
  2. Create a Secret in AWS Secrets Manager.
  3. Add a Secret definition to the Your projects menu.
  4. Use the API Key property drop-down in the Stripe Query component to select the API key you have created by this process.

Obtain an API key

  1. Log in to the Stripe developer dashboard.
  2. Click Developers in the upper-right of the dashboard.
  3. Click the API keys tab.
  4. In the Standard keys section, locate the Publishable key and click the key's Token to copy it. This is your API key.

Create an AWS Secret

Create a secret in AWS Secrets Manager. This must be in the same AWS Region as the agent selected when the project was created.

  1. Log on to the AWS console, and in the search bar search for Secrets Manager to access the Secrets page.
  2. Click Store a new secret.
  3. Select Other type of secret and enter a Key/value pair, in which:
    • Key is a name denoting a Stripe API key entry.
    • Value is the literal Stripe API key.
  4. Click Next and on the next page enter a Secret name. This is the name that will appear in the Secret definitions list in your Your projects.
  5. The remainder of the details are not needed, so click Next and Next again, then Store to complete the creation of the secret.

Add a secret definition

Follow the steps in Add new secret definition.

Return to Designer

  1. Return to the Stripe Query component in Designer.
  2. Click into the API Key property.
  3. Select your new secret definition representing your Stripe API key.
  4. Click Save.