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 to store the Stripe API key.
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, as this Stripe API key will be required when creating the secret.

---

Create a secret

You must create a secret to store your Stripe API key. How this secret is stored depends on your Data Productivity Cloud deployment model:

• In a Full SaaS deployment model, you must add a secret to the internal managed vault service that is hosted in Matillion's own AWS infrastructure. Read Secrets and secret definitions for details.
• In a Hybrid SaaS deployment model, you must add a secret to either AWS Secrets Manager or Azure Key Vault in your own cloud infrastructure, as described below.
• In a Hybrid SaaS deployment model using Matillion Agent for Snowflake, read Secrets in Matillion Agent for Snowflake for details of how to store the secret in a Snowflake schema.

AWS Secrets Manager

1. Log in to the AWS account that houses your agent. This must be in the same AWS Region as the agent selected when the project was created.
2. In the search bar search for Secrets Manager to access the Secrets page.
3. Click Store a new secret.
4. Select Other type of secret and create a Key/value pair with the following details:
   • Key: Enter a label you will use to identify the token.
   • Value: Enter the Stripe API key code you copied earlier.
5. 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 projects.
6. The remainder of the details aren't needed, so click Next and Next again, then Store to complete the creation of the secret.

Azure Key Vault

1. Log in to the Azure account that houses your agent. This must be in the same Azure Region as the agent selected when the project was created.
2. Click Key vaults and click the name of the key vault you want to reference. If there is only one, then this will be the [Default] key vault configured in the agent.
3. Click Objects and then click Secrets.
4. Click + Generate/Import.
5. On the Create a secret screen enter the following:
   • Upload options: Select Manual.
   • Name: Type a name for the secret. The secret name must be unique within a key vault. For more information on naming, read Key Vault objects, identifiers, and versioning.
   • Secret value: Enter the Stripe API key code you copied earlier.
6. Click Create.

---

Add a secret definition

Follow the steps in Secrets and secret definitions.

---

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.

Got feedback or spotted something we can improve?

We'd love to hear from you. Join the conversation in the Documentation forum!