Run the Quickstart
A quick introduction to how you’ll be building with Plaid Auth.
Let’s test out running Plaid locally by cloning the Quickstart app. You’ll need API keys, which you can receive by signing up in the Dashboard.
You'll have two different API keys, and there are three different Plaid environments. Today we'll start in the Sandbox environment. View the API Keys section of the Dashboard to find your Sandbox secret.
Set up the Quickstart
Once you have your API keys, it's time to run Plaid locally! Select both your client-side and server-side preferences to tailor your Quickstart.
1# Note: If on Windows, run2# git clone -c core.symlinks=true https://github.com/plaid/quickstart3# instead to ensure correct symlink behavior45git clone https://github.com/plaid/quickstart.git6cd quickstart/node78# Copy the .env.example file to .env, then fill9# out PLAID_CLIENT_ID and PLAID_SECRET in .env10cp .env.example .env1112# Install dependencies13npm install1415# Start the backend app16./start.sh
Now that you have the Quickstart running, you’ll add your first Item in the Sandbox environment. Once you’ve opened the Quickstart app on localhost, open Link and select any institution. Use the Sandbox credentials to simulate a successful login.
1username: user_good2password: pass_good
How it works
As you might have noticed, you'll be using both your app's server and client to add Plaid to your app. Here is an overview of how you'll be using Plaid.
/link/token/createto create a
link_tokenand pass the temporary token to your app's client.
link_tokento open Link for your user. In the
onSuccesscallback, Link will provide a temporary
/item/public_token/exchangeto exchange the
public_tokenfor a permanent
item_idfor the new
access_tokenand use it to make product requests for your user's
Be sure to store your
access_tokens in order to make API requests for that
Once you’ve successfully added an Item, the Quickstart allows you to simulate
API requests. We’ve started the app with
auth, so only the Auth product
requests will work. Try adding other products to the run script with
PLAID_PRODUCTS=auth,transactions,balance to test them out.
Congrats! You’re all ready to dive right in to modifying Quickstart requests.