Verify the Platform Connector
Once you have created a server and implemented Platform Event Notifications, there are several ways you can test that your Platform Connector functions as expected.
Prerequisites
- Complete the instructions in the Getting Started, Implement Platform Connector APIs, and Implement Platform Event Notifications pages.
- Connect a store to your Platform Connector.
Verify Platform Connector endpoints
There are several ways to trigger requests from Bold to your Platform Connector endpoints.
Sync with Bold on install
Before you can begin using your Platform Connector, Bold must sync with the information on your platform. Bold completes this sync upon installation of Bold Checkout or another app. Bold calls several of your Platform Connector endpoints during this process, including the following:
Install the Bold Checkout app on your store using the Bold Account Center. If the app is already installed, you can uninstall and reinstall it on your store to trigger the sync again.
If your platform connector works properly, you can access your customers and products from within the Bold Checkout admin using the following steps:
- In the Bold Checkout admin, navigate to Orders, then Create Order.
- Use the Order items field to look up products by SKU and verify that Bold synced your products.
- Use the Customer lookup field to look up customers by email verify that Bold synced your customers.
The following screenshot shows this interface:
Test Bold Checkout and Subscriptions functionality
You can also verify the functionality of your Platform Connector by testing the expected user behavior on your storefront. For example, if a shopper completes a new order, this triggers a call to Bold Checkout's Process Order endpoint, which in turn calls your Platform Connector's Create Order endpoint.
The following table shows how to trigger calls from Bold to your Platform Connector:
| Platform Connector Endpoint | Bold Checkout Triggers | Bold Subscriptions Triggers |
|---|---|---|
| Create Customer | Create an order with the Initialize Order endpoint, and call the Process Order endpoint. The order must be for a new customer (no customer with that email already exists). | Create a Bold Subscriptions order via the Create Subscription endpoint. |
| List Customers | Install Bold Checkout. | Install Bold Subscriptions. |
| Delete Customer | Not used by Bold Checkout. | Not used by Bold Subscriptions. |
| Update Customer | Not used by Bold Checkout. | Call to the Update Customer endpoint. |
| Validate Customer JWT | Not used by Bold Checkout. | The frontend loads the customer portal for a logged-in user. |
| Create Address | Not used by Bold Checkout. | Call to the Create Customer Address endpoint. |
| Delete Customer Address | Not used by Bold Checkout. | Call to the Delete Customer Address endpoint. |
| Update Address | Not used by Bold Checkout. | Call to the Update Customer Address endpoint. |
| List Orders | Not used by Bold Checkout. | Not used by Bold Subscriptions. |
| Create Order | Create an order with the Initialize Order endpoint, and call the Process Order endpoint. | Create an order with the Initialize Order endpoint, and call the Process Order endpoint. Additionally, when Bold Subscriptions creates an order recurrence. |
| Get Order | Perform an order update after the order is processed, such as fulfilling the order via the Update Line Item endpoint. | Not used by Bold Subscriptions. |
| Update Order | Perform an order update after the order is processed, such as fulfilling the order via the Update Line Item endpoint. | Not used by Bold Subscriptions. |
| Create Payment | Not used by Bold Checkout. | Not used by Bold Subscriptions. |
| Update Payment | Create and complete a checkout order. Capture a payment via the Bold Checkout admin user interface. | Not used by Bold Subscriptions. |
| List Products | Install Bold Checkout. | Install Bold Subscriptions. |
| List Categories | Install Bold Checkout. | Install Bold Subscriptions. |
Verify Platform Event Notifications
You can also trigger your Platform Event Notifications to update Bold with new data and check whether that data was added to Bold's database.
Create a new entity
First, create a new entity within your platform that Bold does not know about. For example, you can create a new product through your platform's user interface, if applicable.
If configured properly, this action causes your Platform Connector to trigger the Product Saved event notification, which Bold subscribes to. Bold responds with the success message to indicate the notification was received and processed.
Verify product creation
To verify that your new entity was created within the Bold database, make a call to one of the standard Bold API endpoints. For example, to confirm that Bold created your new product, call the List Products endpoint.