Support for API request

[jaimetur]

Hello, I’m currently working in this project: https://github.com/jaimetur/OrganizeTakeoutPhotos

and I would like to include a feature to copy all photos within Synology Photos albums into physical folder.

I have just found that this script can do it and I would like to integrate this API into my script. Could you please support me with the API call and method that you used to get this work?

My script is coded on Python, I don’t have any knowledge of rust

thank you so much in advance

[Caleb9]

Hi @jaimetur,

Do you wish to export it to any folder on DSM, or to a folder controlled by Synology Photos (i.e. located under /home/Photos directory or photo shared folder)?

This app can only do the latter.

[jaimetur]

A folder within Synology Photos is ok for me

[jaimetur]

What I would like to know is how do you list and download all the photos within a Synology Photos album. Do you use the api SYNO.Foto.Browse.Album and SYNO.Foto.Download or any other API? Do you iterate with SYNO.Foto.Download With all items in the album to download them into a Synology Photos folder? How do you get the items and path?

[Caleb9]

In this app I am not downloading anything, just calling the API to list or copy things around, but you're probably on the right track with that SYNO.Foto.Download if you need it.

Here's the gist for listing the photos in an album:

• SYNO.API.Auth - login to Synology Photos, gets either a cookie or a session id which you need to attach to all the subsequent requests

Next:

• SYNO.Foto.Browse.Album - list "owned" albums
• SYNO.Foto.Sharing.Misc - list "shared with me" albums

Using one of the above you can obtain an album id, which you'll need in the next one:

• SYNO.Foto.Browse.Item - list photos in an album, this gives you ids of the photos and their paths on the NAS.

Having ids of the individual photos, copying them to a folder:

• SYNO.Foto.Browse.Folder - get and create a folder (depending on the "method" parameter)
• SYNO.Foto.BackgroundTask.File and SYNO.FotoTeam.BackgroundTask.File - copy photos from either private or shared space to a folder. Note that this uses the "background task" API so copying occurs on the NAS itself, without downloading any files to your local machine.

The way I figured out most of the API and other params for the requests was to inspect traffic using developer tools in a browser while doing things in Synology Photos web UI.

Does it help? :)

[jaimetur]

Thank you. Yes it helped me a lot. I finally managed to include option to extract albums from Synology Photos (option -sea) on my Script: https://github.com/jaimetur/OrganizeTakeoutPhotos My next step is add support for Immich photos but I have no investígate Immich api yet. Thanks again

[Caleb9]

Nice. Immich API is actually way better designed than Synology Photos, so you should not have problems. Good luck! :)

[jaimetur]

Hi again, I would like to ask if you managed to upload files to Synology Photos using API REST. Right now I was able to only manipulate indexed files within Synology Photos root folder, but now I'm trying to investigate how to upload/download files from/to a local folder with Synology Photos API but with no success at this moment.

I share you my Python function to do this (but it returns API error).

It would be nice if you or somebody else could help me with this.

'''
def upload_file_to_synology(file_path, album_name=None):
from LoggerConfig import LOGGER # Import the logger inside the function
stats = os.stat(file_path)
url = f"{SYNOLOGY_URL}/webapi/entry.cgi"

# Verifica si el archivo existe antes de continuar
if not os.path.exists(file_path):
    raise FileNotFoundError(f"El archivo '{file_path}' no existe.")

# Obtiene la información del archivo
stats = os.stat(file_path)
mime_type = mimetypes.guess_type(file_path)[0] or 'application/octet-stream'

file = open(file_path, 'rb')
file.close()
files = {
    'file': open(file_path, 'rb').close(),
}

api_path = 'SYNO.Foto.Upload.Item'
api_version = '1'
method = 'upload'
filename = os.path.basename(file_path)
# url = f'{url}/{api_path}?api={api_path}&version={api_version}&method={method}&_sid={SID}'


# Construcción del payload con el formato correcto
payload = {
    'api': 'SYNO.Foto.Upload.Item',
    'method': 'upload',
    'version': '1',
    'name': os.path.basename(file_path),  # 🔹 Ahora se asegura que `name` esté en los datos
    'uploadDestination': 'timeline',
    'duplicate': 'ignore',
    'mtime': str(int(stats.st_mtime)),
    'folder': '["PhotoLibrary"]'  # 🔹 Se mantiene en formato JSON-string
}

# Carga el archivo como binario en una tupla (clave, (nombre, contenido, tipo_mime))
files = {
    'file': (os.path.basename(file_path), open(file_path, 'rb'), mime_type)
}

HEADERS = {'Content-Type': 'application/json; charset="UTF-8"'}

print(json.dumps(HEADERS, indent=4, ensure_ascii=False))
print(json.dumps(payload, indent=4, ensure_ascii=False))

# Envía la solicitud a la API
response = SESSION.post(url, headers=HEADERS, data=payload, files=files, verify=False)
response.raise_for_status()
data = response.json()
if not data["success"]:
    LOGGER.warning(f"WARNING: Cannot upload asset: '{file_path}' due to API call error. Skipped!")
    return -1

'''

[Caleb9]

Hi. No, I didn't need to upload / download photos. Similar to you I only manipulate them within Photos. But it is surely possible (since you can do that in the Photos' web client). You should open Developer Tools in your browser (F12) and inspect the traffic when you upload / download photos via web client. Then you'll need to replicate that in your Python app. HTH.

[jaimetur]

Hi. No, I didn't need to upload / download photos. Similar to you I only manipulate them within Photos. But it is surely possible (since you can do that in the Photos' web client). You should open Developer Tools in your browser (F12) and inspect the traffic when you upload / download photos via web client. Then you'll need to replicate that in your Python app. HTH.

Yes, this is exactly what I am doing, but even with the inspect, sometimes is not easy to replicate the same API call. I still cannot understand why uploading files is failing since in my code I'm using the same API format that I see in the browser inspector.