Overview
Developers get relevant data flowing into Cordial, empowering marketing teams to build dynamic audiences and send highly personalized messages. It's a foundational role for enterprise messaging.
API first and developer friendly
We built Cordial with developers in mind. A robust RESTful API is available, giving you access to virtually all of the platform's functionality using industry standard GET, POST, PUT, and DELETE calls. Cordial also provides a suite of JavaScript Listeners that can be embedded on your website for a seamless flow of real-time data to your account.
How Cordial stores data
Cordial uses a document-based and search-based database to store all data in the following collections.
| Collection | Description |
|---|---|
| Contact collection | Stores data specific to a contact, including channels, attributes, list membership, and cart items. |
| Events (contact activities) collection | Stores event data specific to messages (opens, clicks, etc.) or any custom-named event. |
| Product collection | Stores data from a product catalog. Developers typically update this collection on a nightly or weekly basis. This data can be used in emails but not audience search. |
| Orders collection | Stores order data. This can hold specific order details and can be used for building audiences. |
| Supplements collection | Stores additional data (store locations, coupon codes, message content, etc.) that doesn’t fit into one of the above collections. |
RESTful API
Cordial's API gives you access to virtually all of the platform's functionality, such as importing and exporting contacts, event, order, product, and message data—as well as sending batch and triggered messages and other job-related activities.
These articles will help get you started with our API:
In our documentation, API calls are grouped according to the following categories:
- Contact management
- Orders, products, and supplements
- Message creation and delivery
- Operations related
API testing
For testing and documentation needs, we built a custom implementation of Swagger to test all available API calls.
Cordial has two distinct API addresses, so it's important to check which one is associated with your account:
- For accounts located at HTTPS://admin.cordial.io/, the associated API URL is https://api.cordial.io/docs/v2/
- For accounts located at HTTPS://usw2.admin.cordial.io/, the associated API URL is https://api.usw2.cordial.io/docs/v2/
Before using Cordial APIs, you'll need to generate an API key.
Embedded JavaScript Listeners
Cordial's JavaScript Listeners can be embedded on your website to identify visitors and pass contact data, custom-named events, orders, and cart items to your account.
Our JavaScript Listeners also store anonymous data about site visitors and pass that data to the appropriate collection once a contact is identified.
Recommended data integrations
- Contact attribute data: Contact data is paramount to any marketing strategy and can be passed to Cordial using the following methods:
- Via the API using the POST/contacts and POST/contactimports.
- Via JavaScript using the cordial.contact() method.
- Contact activity events: Events (also referred to as contact activities) such as cart abandon and browse abandon are essential to triggered messaging strategies. They can be sent to Cordial using these methods:
- Via the API using the POST/contactactivities call.
- Via JavaScript using the cordial.event() method for custom-named events.
- Cart items: Cordial stores cart items in the contact collection, and they can be used for populating message content in cart abandonment messages. Cart items can be passed two ways:
- Via the API using POST/contacts/{primary_key}/cart or POST/contacts/{primary_key}/cartitems.
- Via JavaScript using cordial.cartitem().
- Order data: You can use order data in message content and to build audiences. Order data is used in replenishment campaigns, order surveys, and order confirmation messages. This data can be sent two ways:
- Via the API using the POST/orders call.
- Via JavaScript using the cordial.order() method.
When using order data to send confirmation messages, we recommend using the API method.
- Product data: Product data is used in message content and should be updated on a recurring basis to maintain a current catalog. You can do so:
- Via the API using the POST/products and POST/productimports calls.
Product data is also updated in the product collection when passed along with order data.
Integration tools
Our Scriptable API and Webhooks tools streamline the process of integrating Cordial into your tech stack.
Scriptable API
Cordial's Scriptable API allows you to set custom authentication, responses, and payload schemas that align with Cordial's data structure using Smarty scripts. This simplifies the process of connecting Cordial with other applications that provide value for your business.
Webhooks
Webhooks automatically stream real-time event data from Cordial to external application APIs. You can enable multiple Webhooks, each configured to stream a specified set of system and/or custom events to an external endpoint. This enables you to set up your own near-real-time streaming integrations with third-party APIs or your own internal APIs.
Additional resources
- JSON validator: JSONLint is a tool for checking your JSON for errors when making API calls. Something as simple as a misplaced comma might be causing a problem.
- HTML, JS, and JSON beautifier: jsbeautifier.org will beautify your code and make it easier to read.
- DNS lookup: whatsmydns.net/#NS checks the current IP address of your domain name and DNS record information against multiple name servers located in different parts of the world.
- Postman: Postman is an alternative to Swagger for testing API calls.
Comments
0 comments
Please sign in to leave a comment.