Switch to v4.1 API endpoints

automated_quality_control.py

@@ -8,6 +8,7 @@
 from retry import retry
 
 API_TOKEN = os.environ.get("SCREENLY_API_TOKEN")
+SCREENLY_API_BASE_URL = "https://api.screenlyapp.com"
 REQUEST_HEADERS = {
     "Authorization": f"Token {API_TOKEN}",
     "Content-Type": "application/json",
@@ -21,7 +22,7 @@ def get_team_id() -> str:
     Return the current account's team ID.
     """
     response = requests.get(
-        "https://api.screenlyapp.com/v4.1/teams?is_current=eq.true",
+        f"{SCREENLY_API_BASE_URL}/v4.1/teams?is_current=eq.true",
         headers=REQUEST_HEADERS,
     )
     response.raise_for_status()
@@ -37,7 +38,7 @@ def get_ten_random_assets(team_id: str) -> List[str]:
     Filtering by team_id ensures the token has permission to add them to playlists.
     """
     response = requests.get(
-        f'https://api.screenlyapp.com/v4/assets?select=id&team_id=eq.{team_id}&type=in.("appweb","audio","edge-app","image","video","web")&status=in.("finished","processing")',
+        f'{SCREENLY_API_BASE_URL}/v4.1/assets?select=id&team_id=eq.{team_id}&type=in.("appweb","audio","edge-app","image","video","web")&status=in.("finished","processing")',
         headers=REQUEST_HEADERS,
     )
     response.raise_for_status()
@@ -51,12 +52,23 @@ def get_ten_random_assets(team_id: str) -> List[str]:
 
 def get_screens() -> List[Dict[str, Any]]:
     """
-    Return a list of screens in the account.
+    Return a list of screens in the account. In v4.1, status and in_sync
+    live in the screen_statuses view, so they are embedded and flattened
+    into each screen dict.
     """
 
-    response = requests.get('https://api.screenlyapp.com/v4/screens?select=id,name,hostname,status,in_sync&type=eq.hardware&is_enabled=eq.true', headers=REQUEST_HEADERS)
+    response = requests.get(
+        f'{SCREENLY_API_BASE_URL}/v4.1/screens?select=id,name,hostname,screen_statuses(status,in_sync)&type=eq.hardware&is_enabled=eq.true',
+        headers=REQUEST_HEADERS,
+    )
     response.raise_for_status()
-    return response.json()
+
+    screens = response.json()
+    for screen in screens:
+        screen_status = screen.pop("screen_statuses") or {}
+        screen["status"] = screen_status.get("status", "offline")
+        screen["in_sync"] = screen_status.get("in_sync", False)
+    return screens
 
 
 @retry(AssertionError, tries=10, delay=SCREEN_SYNC_THRESHOLD / 10)
@@ -100,7 +112,7 @@ def get_qc_playlist_ids():
     Get all playlists starting with 'PLAYLIST_PREFIX'.
     """
 
-    response = requests.get("https://api.screenlyapp.com/v4/playlists", headers=REQUEST_HEADERS)
+    response = requests.get(f"{SCREENLY_API_BASE_URL}/v4.1/playlists", headers=REQUEST_HEADERS)
     response.raise_for_status()
 
     qc_playlists = []
@@ -117,19 +129,19 @@ def delete_playlist(playlist_id):
     items must be removed before the playlist itself can be deleted.
     """
     labels_response = requests.delete(
-        f"https://api.screenlyapp.com/v4/labels/playlists?playlist_id=eq.{playlist_id}",
+        f"{SCREENLY_API_BASE_URL}/v4.1/labels/playlists?playlist_id=eq.{playlist_id}",
         headers=REQUEST_HEADERS,
     )
     if not labels_response.ok:
         return False
     items_response = requests.delete(
-        f"https://api.screenlyapp.com/v4/playlist-items?playlist_id=eq.{playlist_id}",
+        f"{SCREENLY_API_BASE_URL}/v4.1/playlist-items?playlist_id=eq.{playlist_id}",
         headers=REQUEST_HEADERS,
     )
     if not items_response.ok:
         return False
     response = requests.delete(
-        f"https://api.screenlyapp.com/v4/playlists?id=eq.{playlist_id}",
+        f"{SCREENLY_API_BASE_URL}/v4.1/playlists?id=eq.{playlist_id}",
         headers=REQUEST_HEADERS,
     )
     return response.ok
@@ -140,7 +152,7 @@ def get_all_screens_label_id():
     Return the ID of the built-in 'all-screens' label.
     """
     response = requests.get(
-        "https://api.screenlyapp.com/v4/labels?type=eq.all-screens",
+        f"{SCREENLY_API_BASE_URL}/v4.1/labels?type=eq.all-screens",
         headers=REQUEST_HEADERS,
     )
     response.raise_for_status()
@@ -152,15 +164,15 @@ def get_all_screens_label_id():
 
 def add_asset_to_playlist(playlist_id, asset_id):
     """
-    Add a single asset to a playlist via the v4 playlist-items endpoint.
+    Add a single asset to a playlist via the v4.1 playlist-items endpoint.
     """
     payload = {
         "playlist_id": playlist_id,
         "asset_id": asset_id,
         "duration": 10,
     }
     response = requests.post(
-        "https://api.screenlyapp.com/v4/playlist-items",
+        f"{SCREENLY_API_BASE_URL}/v4.1/playlist-items",
         headers={**REQUEST_HEADERS, "Prefer": "return=representation"},
         json=payload,
     )
@@ -178,7 +190,7 @@ def assign_playlist_to_all_screens(playlist_id):
         "playlist_id": playlist_id,
     }
     response = requests.post(
-        "https://api.screenlyapp.com/v4/labels/playlists",
+        f"{SCREENLY_API_BASE_URL}/v4.1/labels/playlists",
         headers={**REQUEST_HEADERS, "Prefer": "return=representation, resolution=ignore-duplicates"},
         json=payload,
     )
@@ -201,7 +213,7 @@ def create_qc_playlist():
     }
 
     response = requests.post(
-        "https://api.screenlyapp.com/v4/playlists",
+        f"{SCREENLY_API_BASE_URL}/v4.1/playlists",
         headers={**REQUEST_HEADERS, "Prefer": "return=representation"},
         json=payload,
     )