In addition to platform specific plugins, Clyde provides a REST API implementing the JSON:API specification which allows anyone to get up and running with our platform. We currently provide language bindings for Node.js 10+ and PHP 7.1+, with more to come soon. View the full documentation here.
All requests to the Clyde API must be made over HTTPS and include an authorization header with your API credentials. The value of this header is `clientKey:clientSecret`. Check out our API documentation for more info on authenticating requests.
To get started, you will need to set up a Clyde account. Submit a connection request or reach out to your account manager to obtain login credentials. Once you have logged into the Clyde Dashboard, you can access your API keys by navigating to the Settings page (gear icon in the sidebar) and scrolling down to the Developers section.
Your account will have both test keys and live keys. Both sets of keys can be used to manage your product catalog, but any orders placed with test keys will not be fulfilled or billed for. You can sync your product catalog with Clyde using test keys, place test orders, and then simply switch to live keys when you're ready to start selling contracts to your customers. This way there's no need to configure your program twice.
Use only your test API keys for testing and development. Any orders placed with live keys will be reported to insurers and billed for.
We currently provide official libraries for Node.js 10+ and PHP 7.1+. The full API documentation can be found here.
The Node library can be installed via npm.
The PHP library can be installed via composer.
The following is an outline of how Clyde's API/SDK works.
To start using Clyde, you'll need to sync your product catalog with our system. We'll match your products with appropriate contracts and you'll be ready to offer Clyde on your site. To make sure this process runs smoothly, it's important to keep your catalog in sync with Clyde at all times so you don't miss out on any opportunities for a sale.
If you have a limited catalog or your inventory doesn’t change very frequently you can do this manually through Clyde’s dashboard. You can add individual products by filling out a simple form, or you can download a CSV template and upload thousands of products at a time.
Once your catalog has been added to Clyde it’s important that you keep pricing up to date. We recommend setting up your system to report price changes to Clyde via our products API. The products API allows you to add new products, update existing products by SKU, or delete products that you no longer offer on your store.
When Clyde matches products in your store's catalog to contracts in our database, we send those contracts back to your CMS. The contracts exist in your system as additional products that need to be labeled "Clyde Protection Plans." All Clyde Protection Plans should use the following product image:
Keep in mind that Clyde needs the list price (before discounts) of all items in order to properly match them with contracts.
When a customer lands on a product page, you’ll want to prompt them to add protection to their purchase. Clyde provides an easy to use widget that handles fetching contracts and rendering various calls-to-action, making setup simple with a consistent and professional look and feel.
Clyde’s easy to implement widget provides a consistent look and feel for adding protection across one or multiple storefronts, as well as satisfying sensitive regulatory requirements. You can read more about the widget here.
If your store is not using the Clyde widget, you have the option of building your own custom CTAs. To satisfy regulatory requirements, you will still need to include the following stamp near your CTAs:
When a customer adds a warranty to their purchase you’ll need to collect payment from them and report the sale to Clyde. It's recommended that you add a dynamically priced item to the cart for checkout in real time as it allows for more flexibility. If your checkout requires that a product be created in advance, you can download a rate sheet containing all of the Contracts matched with your products from our dashboard.
When a customer buys a contract, you need to report the order to Clyde through the create order endpoint. We recommend that reporting all orders, even ones without a contract sale. This makes it possible for customers who don't check out with a protection plan to purchase one later through Clyde's Post-Purchase program. It also enables us to give you additional insight about how your protection program is performing and make suggestions for optimization.
When a customer requests a refund for their purchase, you will need to refund the Warranty by cancelling the Contract Sale. This can be done either by sending a cancellation request for the entire order or by cancelling an individual contract sale on an order. You can also cancel contracts on an order through your Dashboard.