Merge branch 'feature/signed-urls'

# Conflicts:
#	CloudConvert.API/CloudConvertAPI.cs

Author: josiasmontag

CloudConvert.API/CloudConvertAPI.cs

@@ -34,6 +34,7 @@ public interface ICloudConvertAPI
 
     Task<string> UploadAsync(string url, byte[] file, string fileName, object parameters);
     bool ValidateWebhookSignatures(string payloadString, string signature, string signingSecret);
+    string CreateSignedUrl(string baseUrl, string signingSecret, JobCreateRequest job, string cacheKey = null);
   }
 
   public class CloudConvertAPI : ICloudConvertAPI
@@ -45,9 +46,10 @@ public class CloudConvertAPI : ICloudConvertAPI
     readonly string _api_key = "Bearer ";
     const string sandboxUrlApi = "https://api.sandbox.cloudconvert.com/v2";
     const string publicUrlApi = "https://api.cloudconvert.com/v2";
-
     const string sandboxUrlSyncApi = "https://sync.api.sandbox.cloudconvert.com/v2";
     const string publicUrlSyncApi = "https://sync.api.cloudconvert.com/v2";
+    static readonly char[] base64Padding = { '=' };
+
 
     public CloudConvertAPI(string api_key, bool isSandbox = false)
     {
@@ -212,6 +214,25 @@ private HttpRequestMessage GetMultipartFormDataRequest(string endpoint, HttpMeth
 
     public Task<string> UploadAsync(string url, byte[] file, string fileName, object parameters) => _restHelper.RequestAsync(GetMultipartFormDataRequest($"{url}", HttpMethod.Post, file, fileName, GetParameters(parameters)));
 
+    public string CreateSignedUrl(string baseUrl, string signingSecret, JobCreateRequest job, string cacheKey = null)
+    {
+      string url = baseUrl;
+      string jobJson = JsonConvert.SerializeObject(job);
+      string base64Job = System.Convert.ToBase64String(Encoding.ASCII.GetBytes(jobJson)).TrimEnd(base64Padding).Replace('+', '-').Replace('/', '_');
+      
+      url += "?job="  + base64Job;
+
+      if(cacheKey != null) {
+        url += "&cache_key=" + cacheKey;
+      }
+
+      string signature = HashHMAC(signingSecret, url);
+
+      url += "&s=" + signature;
+
+      return url;
+    }
+
     public bool ValidateWebhookSignatures(string payloadString, string signature, string signingSecret)
     {
       string hashHMAC = HashHMAC(signingSecret, payloadString);

CloudConvert.Test/TestSignedUrl.cs

@@ -0,0 +1,56 @@
+
+using CloudConvert.API;
+using CloudConvert.API.Models.JobModels;
+using CloudConvert.API.Models.TaskOperations;
+using CloudConvert.API.Models.ImportOperations;
+using CloudConvert.API.Models.ExportOperations;
+using NUnit.Framework;
+
+
+namespace CloudConvert.Test
+{
+  public class TestSignedUrl
+  {
+    const string apiKey = "";
+    readonly ICloudConvertAPI _cloudConvertAPI = new CloudConvertAPI(apiKey, true);
+
+    [Test]
+    public void Sign()
+    {
+
+      string baseUrl = "https://s.cloudconvert.com/b3d85428-584e-4639-bc11-76b7dee9c109";
+      string signingSecret = "NT8dpJkttEyfSk3qlRgUJtvTkx64vhyX";
+      string cacheKey = "mykey";
+      
+      JobCreateRequest job = new JobCreateRequest
+      {
+        Tasks = new
+        {
+          import_example_1 = new ImportUploadCreateRequest(),
+          convert = new ConvertCreateRequest
+          {
+            Input = "import_example_1",
+            Input_Format = "pdf",
+            Output_Format = "docx"
+          },
+          export = new ExportUrlCreateRequest
+          {
+            Input = "convert"
+          }
+        },
+    
+      };
+
+
+      string signedUrl = _cloudConvertAPI.CreateSignedUrl(baseUrl, signingSecret, job, cacheKey);
+
+
+      StringAssert.StartsWith(baseUrl, signedUrl);
+      StringAssert.Contains("?job=", signedUrl);
+      StringAssert.Contains("&cache_key=mykey", signedUrl);
+      StringAssert.Contains("&s=05521324eb16876aac906f2edc42a7ebfe6e71743e6cb965c4b3bf224c2b581f", signedUrl);
+
+
+    }
+  }
+}

README.md

@@ -120,7 +120,38 @@ var isValid = _cloudConvertAPI.ValidateWebhookSignatures(payloadString, signatur
 // returns true or false
 ```
 
-## Using Sandbox
+## Signed URLs
+
+Signed URLs allow converting files on demand only using URL query parameters. The .NET SDK allows to generate such URLs. Therefore, you need to obtain a signed URL base and a signing secret on the [CloudConvert Dashboard](https://cloudconvert.com/dashboard/api/v2/signed-urls).
+
+```c#
+var signedUrlBase = 'https://s.cloudconvert.com/...'; // You can find it in your signed URL settings.
+var signingSecret = '...'; // You can find it in your signed URL settings.
+var cacheKey = 'cache-key'; // Allows caching of the result file for 24h
+
+var job = new JobCreateRequest
+      {
+        Tasks = new
+        {
+          import_example_1 = new ImportUploadCreateRequest(),
+          convert = new ConvertCreateRequest
+          {
+            Input = "import_example_1",
+            Input_Format = "pdf",
+            Output_Format = "docx"
+          },
+          export = new ExportUrlCreateRequest
+          {
+            Input = "convert"
+          }
+        },
+};
+
+string signedUrl = _cloudConvertAPI.CreateSignedUrl(baseUrl, signingSecret, job, cacheKey)
+// returns the signed URL
+```
+
+## Using the Sandbox
 
 You can use the Sandbox to avoid consuming your quota while testing your application. The .net SDK allows you to do that.