Intended Audience

This page describes who the Yanshan Meeting Big Data System API is designed for and what background you need to work with it effectively. Understanding the intended audience helps you determine whether this documentation applies to your role and how to orient your integration work. The system is built around a locally hosted web service, so your primary interactions are HTTP requests and responses rather than desktop UI operations.

Primary Audience

This documentation is written for intermediate-level developers who are integrating with, extending, or automating the Yanshan Meeting Big Data System. You are expected to be comfortable with HTTP-based APIs, reading JSON request and response payloads, and constructing URLs with explicit port numbers.

You are not the end user of the web interface — that role belongs to the 书记员 (meeting secretary), who operates the system by launching it with 启动系统.bat and interacting through a browser. As a developer, you work with the API Layer that sits behind that interface, sending HTTP requests to retrieve and manipulate meeting data programmatically.

What You Need to Know Before Starting

Because the system runs as a local web service rather than a cloud-hosted platform, a few aspects of the deployment model directly affect how you call the API:

• Host and port: The Web Application Server always listens on port 3005. On the secretary's machine, the base URL is http://localhost:3005. From any other machine on the same local area network, the base URL is http://<secretary-machine-IP>:3005. There is no DNS hostname or domain — you must know the IP address of the host machine.
• No installation required on the host: The package bundles node.exe directly, so the runtime environment is fixed and self-contained. You do not need to manage Node.js versions or runtime dependencies on the host machine.
• Network scope: The API is reachable only within the local area network (LAN). It is not exposed to the public internet by default. Plan your integration accordingly — your client application must be on the same LAN as the host machine, or connected to it via VPN or similar means.

What You Are Not Expected to Do

You do not need to operate or configure the server yourself. Starting the service is the secretary's responsibility via 启动系统.bat. Your role begins once the server is running and you can reach http://localhost:3005 or http://<secretary-machine-IP>:3005 from your client.

You also do not need to install Node.js, npm, or pnpm — the bundled runtime handles execution transparently.

Skills Assumed

• Constructing and sending HTTP requests (GET, POST, etc.)
• Reading and writing JSON
• Basic familiarity with URL structure, including host, port, and path segments
• Ability to find the IP address of a Windows 10 machine on a local network

Verify the API is reachable from your development machine

Once 启动系统.bat has been launched on the secretary's computer, confirm that the API layer is responding before you begin integration work. Replace 192.168.1.50 with the actual IP address of the secretary's machine.

curl http://192.168.1.50:3005

Expected outcome: an HTTP response (status code and body) from the Web Application Server, confirming the service is up and reachable over the LAN. The exact response body depends on the endpoint; a 200 OK at the root indicates the server is running.

Verify local access on the secretary's machine

If you are running your API client directly on the secretary's computer, use localhost instead of an IP address:

curl http://localhost:3005

Expected outcome: the same HTTP response as above, served from the locally running Web Application Server on port 3005.

• 便携部署包 (Portable Package): Understand what is included in the ZIP archive and why no additional installation is required — relevant context for knowing the constraints of the runtime environment your API calls target.
• 端口 3005 (Port 3005): Details on how the application's network port is configured and how to construct correct base URLs for your HTTP requests.
• 局域网访问 (LAN Access): How other devices on the same local network reach the Web Application Server, which determines the network topology your API client must account for.
• 书记员 (Secretary / Operator): The end-user role that operates the system; understanding their workflow clarifies the operational context in which your API integration runs.