Your first API Explorer request
Step 1: Sign Up as an Intuit Developer
Already have an Intuit Developer Account? Then sign in and skip to Step 2 below.
- Go to developer.intuit.com
- Click the Join button.
- Fill out your information and click Sign Up.
Step 2: Create Your X.509 Certificate
(Learn More about X.509 certification creation)
To generate a X.509 certificate you need access to an environment that can run openSSL commands.
Follow these steps to generate a cert file.
- Open up a terminal or command line application.
- Copy and paste this command into your terminal, to generate your .crt and .key files
openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout testapp1.key -out testapp1.crt
openssl.exe req -x509 -nodes -days 365 -newkey rsa:1024 -keyout testapp1.key -out testapp1.crt
- Click enter to run the command.
- You are prompted to enter in information. Fill out the information--fake information is fine.
- You should now have your X.509 certificate files with the file names testapp1.key and testapp1.crt.
- testapp1.crt is your public certificate file.
- testapp1.key is your private certificate file.
- The files are located in the directory you ran the openssl command.
- You can type pwd to figure out the location of the files or use a search feature of your operating system.
- Copy and paste this command into your terminal, to package the .crt and .key file into a .pfx file.
openssl pkcs12 -export -in testapp1.crt -inkey testapp1.key -out testapp1.pfx
openssl.exe pkcs12 -export -in testapp1.crt -inkey testapp1.key -out testapp1.pfx
- Click enter to run the command.
- You are prompted to enter a password. Create a password and save it for when you use the .pfx file.
- You should now have your PKCS#12 file with the file name testapp1.pfx.
Step 3: Create Your API Test Application
- Go to https://developer.intuit.com/AggCat/Create
- If the page asks you to complete your profile, do that now.
- Add your App Name, example: My API Explorer App.
- Click upload a file to upload your X.509 public certificate.
- Upload the testapp1.crt file for this step.
- Click no for each of the options at the bottom of the page.
- Click Continue.
- Click Confirm.
Your authorization key, token, and secret are now in the Unique OAuth Key and SAML ID section.
Note: During the testing phase, you will have a limited (throttled) number of test customers and accounts that are eligible for acquiring data (maximum of 20 customers, and 10 associated financial accounts). If you have a business need to test more than this, please submit a support ticket with your specific request. In the development access environment. Batch files are not available
Step 4: Use the API Explorer to Make API Calls
- Go to the https://developer.intuit.com/apiexplorer site.
- Click Customer Account Data.
- Choose the app name you entered at step 2.2 from the Select App Integration dropdown.
- Enter the End User ID and Password you created at step 2.8 for the X509 Private Key Password.
- Click Upload a file to navigate to your .pfx file. Upload the testapp1.pfx file for this step.
- Click Submit.
- Now you are authenticated.
- Click getInstitutions.
- Click Read.
- Click Try it!
This request pulls down thousands of financial institutions so it will take a couple minutes to return
Congratulations, you have successfully made your first API call!