feat: Add 1st draft for the Neoland API endpoints NEO-3998

docs/neopolis/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "[WIP] Neopolis API",
+  "label": "Neopolis API",
   "link": {
     "type": "generated-index"
   }

docs/neopolis/authentification.md

@@ -0,0 +1,11 @@
+---
+sidebar_position: 2
+---
+
+# Authentification
+
+The API endpoint can be found at `https://prod.neopolis.app`
+
+## API Authentification
+
+TODO

docs/neopolis/get-land-activity.md

@@ -0,0 +1,64 @@
+---
+sidebar_position: 5
+---
+
+# Land Activity
+
+```
+POST https://prod.neopolis.app/public/getLandActivity
+
+{
+	"land_id": "LAND_ID",
+	"days": 7
+}
+```
+
+<details>
+<summary>Example Response</summary>
+<p>
+
+```
+{
+  "status": "ok",
+  "success": {
+    "ad_viewed": [
+      18,
+      100,
+      (...)
+    ],
+    "neocoin_opened": [
+      123,
+      193,
+      (...)
+    ],
+    "cards_opened": [
+      90,
+      50,
+      (...)
+    ],
+    "heist_successful": [
+      8,
+      19,
+      (...)
+    ],
+    "building_created": [
+      2,
+      9,
+      (...)
+    ],
+    "unique_visitors": [
+      131,
+      109,
+      (...)
+    ],
+    "iap_purchased": [
+      1,
+      3,
+      (...)
+    ]
+  }
+}
+```
+
+</p>
+</details>

docs/neopolis/get-parties-ranking.md

@@ -0,0 +1,76 @@
+---
+sidebar_position: 4
+---
+
+# Party Ranking
+
+## Get global ranking
+
+```
+POST https://prod.neopolis.app/public/getPartiesRanking
+
+{
+    "page": 1
+}
+```
+
+<details>
+<summary>Example Response</summary>
+<p>
+
+```
+{
+  "status": "ok",
+  "success": {
+    "ranking": [
+      {
+        "id": "PARTY_ID",
+        "name": "Party Name",
+        "score": 10000,
+        "logo": "5_4_0",
+        "level": 20,
+        "members_count": 15,
+        "members_max_bonus": 0,
+        "city_id": "fr_Paris",
+        "city_name": "Paris"
+      },
+      (...)
+    ],
+}
+```
+
+</p>
+</details>
+
+:::info
+
+The 1st page is `1` , not `0` . Page `0` is actually the last page.
+
+:::
+
+## Get ranking details for a party
+
+```
+POST https://prod.neopolis.app/public/getPartyRanking
+
+{
+    "party_id": "PARTY_ID"
+}
+```
+
+<details>
+<summary>Example Response</summary>
+<p>
+
+```
+{
+  "status": "ok",
+  "success": {
+    "city": 1, // Ranking within the party's city
+    "global": 1 // Global ranking
+  }
+}
+```
+
+</p>
+</details>

docs/neopolis/get-users-ranking.md

@@ -0,0 +1,80 @@
+---
+sidebar_position: 3
+---
+
+# User Ranking
+
+## Get global ranking
+
+```
+POST https://prod.neopolis.app/public/getUsersRanking
+
+{
+    "page": 1
+}
+```
+
+<details>
+<summary>Example Response</summary>
+<p>
+
+```
+{
+  "status": "ok",
+  "success": {
+    "ranking": [
+      {
+        "id": "USER_ID",
+        "name": "Username",
+        "discriminator": "2001",
+        "score": 1000000,
+        "avatar": 13,
+        "city_id": "de_Berlin",
+        "city_name": "Berlin"
+      },
+      (...)
+    ],
+}
+```
+
+</p>
+</details>
+
+:::info
+The users are ordered by score, meaning the 1st user in the reponse is the player with the most score.
+:::
+
+:::caution
+The top of the ranking starts at `page = 1` , not `0` .
+:::
+
+## Get ranking details for a single user
+
+```
+POST https://prod.neopolis.app/public/getUserRanking
+
+{
+    "user_id": "USER_ID"
+}
+```
+
+<details>
+<summary>Example Response</summary>
+<p>
+
+```
+{
+  "status": "ok",
+  "success": {
+    "city": 100,
+    "global": 1200,
+    "league": "master_3",
+    "league_progress": 1,
+    "score": 1000000,
+    "top_percent": 3
+  }
+}
+```
+
+</p>
+</details>

docs/neopolis/intro.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 1
 ---
 
 # Introduction