Onboarding

The customer experience of using the Lockstep platform in your app

To attach your product to the Lockstep Platform, your customers will go through the Lockstep directed onboarding experience. Here's how using the Lockstep API and platform works. For more information about customizing the onboarding experience, please contact us.

API Keys and Bearer Token

As a developer, your code will integrate directly with Lockstep. You'll make API calls using an API key provided by each customer. This customer retains full control of their data, but they allow you access to use it and to work with it.
The customer can enable or disable your API key at any time.

If your program works with multiple customers, you will have a separate API key for each customer. Each API key is restricted to fetching data for that one customer.

Onboarding Experience

When you send your customers into the Lockstep API onboarding experience, they will first be asked whether they want to link an existing Lockstep platform account or create a new one. If the user chooses to create a new account, they will be brought to the Accounting Connector screen.

976976

Your customers will see a pre-selected list of connectors that provide the data you need. You can work with the Lockstep platform team to customize the list of connectors that show up in your onboarding experience.

Connect to Accounting System

After a user selects the accounting system, Lockstep will connect to the accounting or ERP system and begin downloading the first batch of data. When this task completes, you will have access to this company's data through the unified Lockstep API.

982982

After the accounting system connection is complete, the Lockstep onboarding page will post back to your defined return page and include the API key for this customer. You can then resume your work and make API calls to retrieve this customer's data.


Did this page help you?