Getting Started

1. Log into your staging/demo account in Yardstik

2. Navigate to the Developer page and select API Keys

3. Enter the Name for the API key and click the Create button

   

4. Click the copy icon to copy the api key to your clipboard.

5. Paste the API key somewhere safe as it will not be displayed again.

6. Once the key is pasted somewhere safe, you can click the green I have copied my API key button

7. Create a .env file on the root of the project based on the .env.example, then update it to include the YARDSTIK_ACCOUNT_ID, YARDSTIK_REPORT_ID, and YARDSTIK_ACCOUNT_EMAIL.

8. Set the YARDSTIK_API_KEY environment variable with the api-key you created in Getting Started section.

9. Set the YARDSTIK_API_URL environment variable to https://api.yardstik-staging.com.

10. Run yarn server to start up the back end.

11. Run yarn start to start up the front end.

12. Or yarn start:all to start up both server and client

Important Notes

1. The demo contemplates connecting with the Yardstik staging API (see step 9 above). Therefore, the YARDSTIK_API_KEY, YARDSTIK_ACCOUNT_ID and other variables must relate to your staging/demo account.
2. The YARDSTIK_API_KEY must belong to account specified in YARDSTIK_ACCOUNT_ID
3. The YARDSTIK_ACCOUNT_EMAIL must be associated with the account specified in YARDSTIK_ACCOUNT_ID
4. The account specified in YARDSTIK_ACCOUNT_ID must be authorized to view the report for the provided YARDSTIK_REPORT_ID.
5. Legal documents will only appear if they are required on your account but have not yet been provided.

Using the App

1. View a candidate report by click on the "Candidate Report" tab in the nav bar:

2. View/sign account disclosures by clicking on the "Account Disclosures" tab in the nav bar:

Viewing Any Other URL in an iFrame

1. In addition to testing the Yardstik Embeddable-SDK library, this demo app can also be used to view any other URL that does not require authentication in an iFrame.
2. If you have a URL that you would like to view in an iFrame (such as a URL for the candidate intake form), set the the SIMPLE_IFRAME_URL variable in the constants.js file to equal such URL.
3. View the URL in an iframe by clicking on the "Simple IFrame" tab in the nav bar.
4. If you view the candidate intake form in the "Simple IFrame" tab, the page will listen for a message posted by the form on completion, and console.log "message received" upon receipt of the message.