Skylab Studio .NET Client

.NET client to interface with Skylab Studio Public API

Installation

$ nuget install SkylabStudio

Example Usage

For all examples, assume:

using SkylabStudio;

var apiClient = new StudioClient("YOUR_SKYLAB_API_TOKEN");

// optional: to configure max concurrent downloads (for when using DownloadAllPhotos method)
//  - defaults to 5 concurrent downloads at a time
// optional: to resize oversized images to be below Skylab dimension limit
//  - defaults to false
var studioOptions = new StudioOptions { MaxConcurrentDownloads = 5, ResizeImageIfOversized = true };
var apiClient = new StudioClient(Environment.GetEnvironmentVariable("SKYLAB_API_TOKEN"), studioOptions);

// Example Job Processing Flow with Callback

// CREATE PROFILE
dynamic profile = await apiClient.CreateProfile(new { name = $"Test Profile", enable_crop = false, enable_color = true });

// CREATE JOB
var jobName = $"test-job";
dynamic job = await apiClient.CreateJob(new { name = jobName, profile_id = profile.id.Value });

// UPLOAD PHOTO
string filePath = "/path/to/photo";
dynamic res = await apiClient.UploadJobPhoto(filePath, job.id.Value);

// QUEUE JOB
dynamic queuedJob = await apiClient.QueueJob(job.id.Value, new { callback_url = "YOUR_CALLBACK_ENDPOINT" });

// NOTE: Once the job is queued, it will get processed then complete
// We will send a response to the specified callback_url with the output photo download urls

// OPTIONAL: If you want this SDK to handle photo downloads to a specified output folder

// FETCH COMPLETED JOB (wait until job status is completed)
dynamic completedJob = await apiClient.GetJob(queuedJob.id.Value);

// DOWNLOAD COMPLETED JOB PHOTOS
JArray photosList = completedJob.photos;
await apiClient.DownloadAllPhotos(photosList, completedJob.profile, "photos/output/");

Error Handling

By default, the API calls return a JSON (JObject) response object no matter the type of response.

Endpoints

List all jobs

api.ListJobs();

Create job

api.CreateJob(new { name = "Test Job", profileId = 123 });

For all payload options, consult the API documentation.

Get job

api.GetJob(jobId);

Update job

api.UpdateJob(jobId, new { name = "Updated Job Name" });

For all payload options, consult the API documentation.

Queue job

api.QueueJob(jobId, new { callback_url = "http://your.endpoint/"});

Delete job

api.DeleteJob(jobId);

Cancel job

api.CancelJob(jobId);

Jobs in front

Use after queueing job to check number of jobs ahead of yours

api.JobsInFront(jobId);

List all profiles

api.ListProfiles();

Create profile

api.CreateProfile(new { name = $"New Profile", enable_crop = false, enable_color = true });

For all payload options, consult the API documentation.

Get profile

api.GetProfile(profileId);

Update profile

api.UpdateProfile(profileId, new { name = $"Test Profile", enable_crop = false, enable_color = true });

For all payload options, consult the API documentation.

Get photo

api.GetPhoto(photoId);

Upload photo

This function handles validating a photo, creating a photo object and uploading it to your job/profile's s3 bucket.

api.UploadJobPhoto("/path/to/photo", jobId);

OR

// Use the following to upload a background photo for a profile (replace bg enabled)
api.UploadProfilePhoto("/path/to/photo", profileId);

If upload fails, the photo object is deleted for you. If upload succeeds and you later decide you no longer want to include that image, use api.DeletePhoto(photoId) to remove it.

Download photo(s)

This function handles downloading the output photos to a specified directory.

JArray photosList = completedJob.photos;

DownloadAllPhotosResult downloadResults = await apiClient.DownloadAllPhotos(photosList, completedJob.profile, "/output/folder/path");
Console.WriteLine($"Success photos: [{string.Join(", ", downloadResults.SuccessPhotos)}]");
Console.WriteLine($"Erorred photos: [{string.Join(", ", downloadResults.ErroredPhotos)}]");

Output:
Success photos: [1.jpg, 2.jpg, 3.jpg]
Erorred photos: [4.jpg]

OR

api.DownloadPhoto(photoId, "/path/to/photo.jpg"); # accepts full path OR
api.DownloadPhoto(photoId, "/path/to/output/folder"); # accepts directory

Delete photo

This will remove the photo from the job/profile's bucket. Useful for when you've accidentally uploaded an image that you'd like removed.

api.DeletePhoto(photoId);

Validate hmac headers

Applicable if you utilize the job callback url. Use to validate the job payload integrity.

• secretKey (string): Obtain from Skylab

• jobJson (string): Stringified json object obtained from callback PATCH request

• requestTimestamp (string): Obtained from callback PATCH request header 'X-Skylab-Timestamp'

• signature (string): Signature generated by Skylab to compare. Obtained from callback PATCH request header 'X-Skylab-Signature'

Returns True or False based on whether or not the signatures match.

api.ValidateHmacHeaders(secretKey, jobJson, requestTimestamp, signature);