Introduction & Requirements
Overview
This guide will walk you through the process of setting up a custom integration with Talk2sync. Before you begin, ensure that your system meets the following requirements.
System Requirements
Your custom application must implement the following to be compatible with Talk2sync:
API Endpoints
- RESTful API endpoints for retrieving products and orders
- JSON format for all requests and responses
- Security key provided by Talk2sync that must be sent in every response header
Minimum Configuration
You will need a minimum of two endpoints (products and orders) and a maximum of four, depending on your use case:
| Endpoint Type | Purpose | Required |
|---|---|---|
| Products | Retrieve and manage product catalog | ✓ Yes |
| Orders | Retrieve and manage sales orders | ✓ Yes |
| Additional Endpoints | Custom business logic | Optional |
Endpoint Structure
All endpoints should follow REST API standards and return JSON responses.
Example Endpoints
https://www.example.com/api/products
https://www.example.com/api/orders
Note: These are examples. You can name your endpoints anything you prefer. For this tutorial, we will use
/api/productsand/api/orders.
Security Header
Every response from your endpoints must include the security key provided by Talk2sync. This key will be generated during the connection setup process (see Step 3: Generate Keys).
For detailed API specifications and request/response formats, refer to the API Specification Documentation.