bcat95/shopee-aff

1. This repository is primarily a reference and demo workspace for Shopee Affiliate APIs, not a full production application. The root README.md is the canonical architecture/documentation entry point and explains the official Shopee Open API and GraphQL surfaces this repo targets.

2. The repo has two documentation domains:

- README.md for the official Shopee Affiliate API.

- product-data-api.md for the non-official Product Data API.

This is an important boundary: the repo intentionally separates “official integration” from “unofficial scraping/data extraction” material.

3. The main external dependency is the Shopee Affiliate platform itself:

- REST/OpenAPI endpoints for product lookups.

- GraphQL queries/mutations for offer lists, affiliate link generation, and conversion/validated reports.

The architecture is therefore an API consumer toolkit around Shopee, with no internal persistence layer shown in the tree.

4. Code/ contains runnable sample clients for the official API in two runtimes:

- Code/nodejs/ for Node.js.

- Code/php/ for PHP.

Both have .env.example files, which indicates secrets and credentials are expected to be injected externally rather than committed.

5. The Node.js sample is the most “application-like” part of the repo:

- index.js is the execution entry point.

- index.test.js shows there is at least some automated validation.

- package.json defines the runtime and dependencies.

Architecturally, this sample likely wraps Shopee request signing/authentication and demonstrates one or more API calls end to end.

6. The PHP sample under Code/php/ is the parallel implementation of the same idea:

- index.php is the entry point.

- .env.example suggests it also relies on credential/config injection.

This gives the repo a language-agnostic integration pattern for Shopee API access.

7. Postman/ is a manual testing and exploration layer:

- Shopee-Product-Data.postman_collection.json

- Shopee-Product-Data.postman_environment.json

These artifacts are for reproducing requests, experimenting with parameters, and validating responses without writing code.

8. bc-custom-link/ is a separate PHP-based utility/demo app with its own mini front-end:

- index.php, link.php, conn.php, func.php

- assets/javascript and assets/stylesheets/custom.css

This looks like a small web tool for generating or managing affiliate/custom links, with a lightweight server-side PHP backend and browser UI assets.

9. The data flow across the repo is consistent:

developer or end user inputs Shopee credentials/config → sample code or custom-link UI builds authenticated requests → requests go to Shopee Affiliate Open API / GraphQL → responses are displayed, tested, or used to create affiliate links / inspect conversions.

There is no evidence of a local database, message queue, or background worker architecture.

10. The important functional boundaries are by API capability, not by service tier:

- Product data retrieval.

- Offer discovery.

- Affiliate link generation.

- Conversion/validated reporting.

These are mapped directly in the docs and likely mirrored in the sample code and Postman collection.

11. From an architecture-diagram perspective, the repo should be drawn as a tooling and documentation hub centered on Shopee APIs, with three consumer surfaces:

- scripted API clients (Code/)

- manual API client artifacts (Postman/)

- a browser-based PHP helper app (bc-custom-link/)

All of them depend on the same external Shopee Affiliate API platform.

12. The repo’s operational assumptions are important:

- credentials/signatures/tokens are required,

- rate limits and cursor expiry matter,

- GraphQL and REST coexist,

- affiliate link creation and conversion reporting are the key business flows.

These constraints shape the implementation, but they are enforced by the Shopee platform rather than by internal infrastructure in this repo.