getting-started:faq

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
getting-started:faq [2025-12-06 00:38] nimdagetting-started:faq [2025-12-06 00:42] (current) nimda
Line 18: Line 18:
  
 **Q: Do I need authentication for a basic lobby browser?** \\ **Q: Do I need authentication for a basic lobby browser?** \\
-A: No! The [[rlink:community:advertisement:findadvertisements|[GET] /community/advertisement/findAdvertisements]]-Endpoint on the Community API provides public lobby data without authentication. Authentication is only needed for:+A: No! The [[rlink:community:advertisement:findadvertisements|[GET] /community/advertisement/findAdvertisements]] endpoint on the Community API provides public lobby data without authentication. Authentication is only needed for:
   * Viewing ongoing ranked games   * Viewing ongoing ranked games
   * Spectator features   * Spectator features
Line 90: Line 90:
  
 **Q: Can I show ongoing ranked games?** \\ **Q: Can I show ongoing ranked games?** \\
-A: Yes, but it requires the authenticated Game API (''findObservableAdvertisements''). The Community API only shows lobbies waiting for players, not matches in progress.+A: Yes, but it requires the authenticated Game API for the [[rlink:game:advertisement:findobservableadvertisements|[GET/POST] /game/advertisement/findObservableAdvertisements (Viewable Public Lobbies)]] endpoint. The Community API only shows lobbies waiting for players, not matches in progress.
  
 ---- ----
Line 103: Line 103:
 **Q: Is there example code I can reference?** \\ **Q: Is there example code I can reference?** \\
 A: Yes! Check these open source projects: A: Yes! Check these open source projects:
-  * ageLANServer (Go) - Complete server implementation with model definitions+  * [[https://github.com/luskaner/ageLANServer|ageLANServer (Go)]] - Complete server implementation with model definitions
   * Various community tools on GitHub   * Various community tools on GitHub
   * Code snippets shared in developer communities   * Code snippets shared in developer communities
Line 111: Line 111:
 **Q: Is it legal to use these APIs?** \\ **Q: Is it legal to use these APIs?** \\
 A: The Community API is public and intended for community use. For the authenticated Game API: A: The Community API is public and intended for community use. For the authenticated Game API:
 +  * Read the [[rlink:usage|Age of Empires API Usage Guidelines]]
   * You must own the game on Steam   * You must own the game on Steam
   * Don't abuse the API or spam requests   * Don't abuse the API or spam requests
  • getting-started/faq.1764977930.txt.gz
  • Last modified: 5 months ago
  • by nimda