This guide will help you embed an importer in your application using OneSchema's in-app Quickstart.

Step 1: Configure allowed domains

Allowed domains are the allowed URLs where the OneSchema embedded importer may appear. This prevents sneaky thieves from stealing your embed and hosting it elsewhere.

Navigate to your developer dashboard and click Edit domains. Add the domains where you use the OneSchema embedded importer. This includes the domain where your application is hosted and the domain you use for development. If a domain is not https, you will need to include the protocol, such as <http://> in the domain.

[Optional] Step 2: Set up a webhook

📘

See this page for a complete list of data import methods.

If you're planning to use a webhook import for the processed data, select Webhooks on the left sidebar of the development dashboard. Add a new webhook, and fill out the necessary information. If you want to try using a webhook, we recommend testing using webhook.site to get a webhook url.

Step 3: Get started using quickstart

Quickstart

Once steps 1 and 2 are complete, Importer Quickstart will appear on your Developer dashboard. Click on it to begin configuring your importer.

In the Quickstart form choose your template and, if using a webhook import, select that as well. You must also configure a JWT.

JWT

A JWT is a way to uniquely identify an individual user. Essentially, this is how OneSchema will be able to tell you who performed the data upload.

During testing, you can hardcode a JWT generated by OneSchema. When moving to production you will need to generate a secure JWT.

Scroll to the bottom of the page to find "JWT Generator" and click Configure.

Next, fill out some sample information. These values will not affect how OneSchema works.

Generate and use snippet

In the bottom right hand corner, click generate snippet for code samples that can used in your codebase. Tabs for HTML and React can be found above the snippet. Select the relevant option and place the code in your codebase to use the OneSchema embedded importer.

If you are using the React snippet, you will need to install the OneSchema importer component from npm before the snippet will work. Do so by running this command in your project directory:

npm i --save @oneschema/react

More info on the SDK here

Done! If you have any questions, please get in touch with your OneSchema team.