Pular para o conteúdo principal

Zeca Integration Documentation

Welcome to the Zeca integration documentation. Zeca is a startup focused on technology solutions that transform the B2B sales experience — providing distributors, manufacturers, and brands with intelligent tools that make salespeople's daily work easier and more productive.

In practice, Zeca offers features like WhatsApp-based ordering — where a user sends a text, image, audio, or PDF with a product list, and our multimodal pipeline extracts items and quantities automatically, creating a cart in under a minute.

This documentation is intended for technical teams integrating external data into the Zeca platform. Whether you are synchronizing your product catalog, importing customer records, or managing field missions, this guide provides the resources you need to connect your systems to Zeca.

Common Terms

Before exploring the APIs, here are a few core concepts you should know:

  • Supplier: The primary clients of Zeca, typically distributors, manufacturers, or brands that use our ecosystem to manage sales operations, product catalogs, and missions.
  • User: Any person related to a supplier who has access to a Zeca solution. Most users are sales representatives.
  • Customer: Any point of sale (POS) belonging to the supplier.
  • Task: The goal or mechanic that defines the basic rule for each POS objective.
  • Sales Resource: The "opportunities", meaning active campaigns, discounts, and promotions.

Integration Methods

There are two primary ways to integrate your data with Zeca:

1. REST APIs

Zeca exposes RESTful APIs for real-time data management. All API requests are authenticated using the x-client-secret header. The APIs are organized into two main surfaces:

  • Base API: Core data management — products, customers, orders, sales groups, users, and AI-powered search.
  • Mission API: Field operations — tasks, CRM, sales resource assignments, and loyalty programs.

Some APIs require specific authorization scopes in addition to the client secret. See the Authentication section of each API reference for details.

2. SFTP & Batch Import

For large-scale data synchronization (thousands of records), Zeca supports SFTP integration. You can upload CSV files for products, customers, and orders, which are processed asynchronously in the background.

  • SFTP Guide: Learn how to format and upload your CSV files.