SynologyClient

Synology Client

This is a .Net implementation of the https API for Synology File Station based on Synology File Station Official API available at synology.com.

Most functions and parameters are commented.
Check out the example and feel free to ask if you are unsure about anything.

NuGet

Features

• Connect
• Login, Logout
• List shared drives
• List files and directories
• Get file info
• Download
• Upload
• Get thumbnails

Planned features

• File sharing

Example

using Synology.DataTypes;
using Synology;
using System.Drawing;

// Connecting and logging in
Client client = new("https://nas.quickconnect.to", 5001, TimeSpan.FromSeconds(10));
if (!client.API.Connect().Result.success)
    return;
if (!client.API.Login("user", "password").Result.success)
    return;

// Getting drives
Response<SharedDriveList> sharedDriveResponse = client.FileStation.ListSharedDrives([]).Result;
Console.WriteLine("Recieved " + sharedDriveResponse.data.shares.Count + " shared drives");

// Getting files
Response<FileList> listResponse = client.FileStation.List("/Pictures", []).Result;
Console.WriteLine("Recieved " + listResponse.data.files.Count + " files");

// Getting info about specific files
Response<FileList> info = client.FileStation.Info(["/Home/note.txt"], [ ListAdditionalParameters.size ]).Result;
Console.WriteLine("File size is " + info.data.files.Last().additional.size);

// Downloading a file
Response<byte[]> downloadResponse = client.FileStation.Download("/Pictures/picture.png").Result;
Console.WriteLine("Downloaded " + downloadResponse.data.Length + " bytes");

// Getting a thumbnail
Response<byte[]> thumbResponse = client.FileStation.Thumbnail("/Pictures/landscape.jpg").Result;
Image image = Image.FromStream(new MemoryStream(thumbResponse.data));
image.Save("C://landscape_thumbnail.jpg");
Console.WriteLine("Thumbnail created!");

// Uploading a file
byte[] bytes = File.ReadAllBytes("C://video.mp4");
Response<HttpResponseMessage> uploadResponse = client.FileStation.Upload("/Pictures", "video.mp4", bytes).Result;
if (uploadResponse.success)
    Console.WriteLine("File uploaded!");

// Logging out
client.API.Logout();

License

MIT