3. Web Services Presentation

Dialog Insight's web services allow developers to integrate the platform with their own systems and applications. Using APIs, you can automate contact management, trigger marketing campaigns, synchronize data, and retrieve real-time statistics.

Several CRUD actions can be performed when calling web services:

• Read or modify data (contacts, segments, campaigns, etc.)
• Connect Dialog Insight to third-party systems (CRM, ERP, e-commerce)
• Automate recurring marketing tasks
• Retrieve reports and performance indicators

The API is accessible via HTTPS and requires authentication (API key). Communication is done in JSON. In this article, you will get a general overview of web services, how they work, and common use cases.

Endpoint Main Categories

Contact Management

Manipulation of the platform’s most central resource: contacts.

• Create a contact
• Update contact profiles
• Search or filter contacts

Segmentation and targeting

Work on lists and segments to target your mailings.

• List the available segments
• Get the contacts of a segment
• Create or update a dynamic segment

Campaigns and communications

Campaign management (emails, SMS or Push).

• Create a campaign
• Trigger a campaign
• Plan or trigger a sending
• Get statistics from a campaign

Data and statistics

Data extraction to analyze your marketing actions.

• Retrieve reports for clicks and views
• Get the mailing history per contact

Typical Use Cases Cas d’utilisation typiques

Here are some concrete examples of calls that you could set up from your first developments.

1. Subscription for a newsletter: When a visitor submits a form, your site calls the API to create their profile in DI.

2. Client data update: A change of address in your CRM triggers an API call to sync the profile in DI.

3. Reminder integrated into an automated campaign: Your e-commerce system detects an abandoned cart and calls an automated scenario in DI.

4. Internal dashboard: An in-house interface queries the DI API to display the opening rate of the latest campaigns in real time.

Best Practices For Getting Started

• Start small: Test your calls in a development environment before aiming for massive syncs.
• Use the official documentation: Each API entry point is documented with its parameters and examples.
• Manage the errors: Provide for handling HTTP status codes (e.g. 400, 401, 404, 500).
• Respect the limit of calls: Avoid intensive call loops that can impact performance.

Next Step

→ Create a test project