<<logged_in_message>>
1Pick a language
2Try it!
Try It! to start a request and see the response here!{user.logged_in_message}
Data Structure
Before you get going and authenticated, here is a quick snapshot about the resources that fall within your account and their relationships to one another. Much of this will be further described within each resource within the reference docs. This high level view might be useful while navigating the remaining documentation.
An account wraps around all of your created record and data to contain them neatly together (tenant). This is why the root resource is always /v3/merchants.
For convenience here are some jump off points to the top level items.
- Applications (not yet available) Tokens
- Products
- Customers
- Business Processes
- Business Process Actions
- Blueprints
- Blueprint Triggers
- Subscriptions (webhooks)
Essentials
If you logged into the API docs you will already have both an Accountand a Customer created. If not, you can click the login button in the top right corner, this is only for API usage convenience it does not feed the sales funnel.
Business Processes
From here, you can focus on understanding Business Processes and their underlying Business Process Actions. This is the building block of engaging with customers. Modeling a customer engagement in a Business Process gives our system the ability to render messages or web experiences to accomplish the goals outlined as individual Business Process Actions.
On the left, scroll down to ACTION CATALOG for a full list of supported actions and how to configure each one.
Blueprints
Blueprints provide simplicity, continuity and structure to Business Processes. This is a critical concept because business processes can be 'anything'. The predictable structure enables wrapper concepts like Blueprint Triggers and Subscriptions to be a touch easier to understand as the data model being shared will no longer keep changing.