You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: Documentation/REST API.md
+21-21
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ REST API requires both public and secret keys:
30
30
let uploadcare =Uploadcare(withPublicKey: "YOUR_PUBLIC_KEY", secretKey: "YOUR_SECRET_KEY")
31
31
```
32
32
33
-
## List of files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/filesList?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
33
+
## List of files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/filesList)) ##
34
34
35
35
```swift
36
36
// Make a list of files object
@@ -85,7 +85,7 @@ filesList.previousPage { list, error in
85
85
}
86
86
```
87
87
88
-
## File info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/fileInfo?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
88
+
## File info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/fileInfo)) ##
89
89
90
90
```swift
91
91
uploadcare.fileInfo(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { file, error in
@@ -97,7 +97,7 @@ uploadcare.fileInfo(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { file, er
97
97
}
98
98
```
99
99
100
-
## Store files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/storeFile?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
100
+
## Store files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/storeFile)) ##
101
101
102
102
Store an individual file:
103
103
@@ -124,7 +124,7 @@ uploadcare.storeFiles(withUUIDs: uuids) { response, error in
@@ -151,7 +151,7 @@ uploadcare.deleteFiles(withUUIDs: uuids) { response, error in
151
151
}
152
152
```
153
153
154
-
## Copy file to local storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/copyFileLocal?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
154
+
## Copy file to local storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/copyFileLocal)) ##
155
155
156
156
```swift
157
157
uploadcare.copyFileToLocalStorage(source: "6ca619a8-70a7-4777-8de1-7d07739ebbd9") { response, error in
## Copy file to remote storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/copyFile?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
166
+
## Copy file to remote storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/copyFile)) ##
167
167
168
168
```swift
169
169
let source ="99c48392-46ab-4877-a6e1-e2557b011176"
@@ -176,7 +176,7 @@ uploadcare.copyFileToRemoteStorage(source: source, target: "one_more_project", m
176
176
}
177
177
```
178
178
179
-
## List of groups ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/groupsList?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
179
+
## List of groups ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/groupsList)) ##
180
180
181
181
```swift
182
182
let query =GroupsListQuery()
@@ -220,7 +220,7 @@ groupsList.previousPage { list, error in
220
220
}
221
221
```
222
222
223
-
## Group info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/groupInfo?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
223
+
## Group info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/groupInfo)) ##
224
224
225
225
```swift
226
226
uploadcare.groupInfo(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { group, error in
@@ -232,7 +232,7 @@ uploadcare.groupInfo(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { group
232
232
}
233
233
```
234
234
235
-
## Store group ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Group/paths/~1groups~1%3Cuuid%3E~1storage~1/put?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
235
+
## Store group ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Group/paths/~1groups~1%3Cuuid%3E~1storage~1/put)) ##
236
236
237
237
```swift
238
238
uploadcare.storeGroup(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { error in
This method allows you to get an authenticated URL from your backend by using redirect.
262
262
To answer a request to that URL, your backend should generate an authenticated URL to your file and perform REDIRECT to a generated URL. A redirected URL will be caught and returned in the completion handler of that method.
@@ -276,7 +276,7 @@ uploadcare.getAuthenticatedUrlFromUrl(url) { value, error in
276
276
}
277
277
```
278
278
279
-
## List of webhooks ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/webhooksList?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
279
+
## List of webhooks ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/webhooksList)) ##
280
280
281
281
```swift
282
282
uploadcare.getListOfWebhooks { value, error in
@@ -289,7 +289,7 @@ uploadcare.getListOfWebhooks { value, error in
Create and subscribe to a webhook. You can use webhooks to receive notifications about your uploads. For instance, once a file gets uploaded to your project, we can notify you by sending a message to a target URL.
@@ -355,7 +355,7 @@ uploadcare.convertDocumentsWithSettings([task1, task2]) { response, error in
355
355
}
356
356
```
357
357
358
-
Alternatively, you can pass custom "paths" param as array of strings (see ([documentation](https://uploadcare.com/docs/transformations/document_conversion/#convert-url-formatting?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift))):
358
+
Alternatively, you can pass custom "paths" param as array of strings (see ([documentation](https://uploadcare.com/docs/transformations/document_conversion/#convert-url-formatting))):
359
359
360
360
```swift
361
361
uploadcare.convertDocuments([":uuid/document/-/format/:target-format/"]) { response, error in
## Document conversion job status ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Conversion/paths/~1convert~1document~1status~1{token}~1/get?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
371
+
## Document conversion job status ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Conversion/paths/~1convert~1document~1status~1{token}~1/get)) ##
372
372
373
373
```swift
374
374
uploadcare.documentConversionJobStatus(token: 123456) { job, error in
@@ -387,7 +387,7 @@ uploadcare.documentConversionJobStatus(token: 123456) { job, error in
387
387
}
388
388
```
389
389
390
-
## Convert video ([API Reference](https://uploadcare.com/docs/transformations/video_encoding/#video-encoding?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
390
+
## Convert video ([API Reference](https://uploadcare.com/docs/transformations/video_encoding/#video-encoding)) ##
391
391
392
392
You can convert multiple video files with one request:
393
393
@@ -414,7 +414,7 @@ uploadcare.convertVideosWithSettings([task1, task2]) { response, error in
414
414
}
415
415
```
416
416
417
-
Alternatively, you can pass custom "paths" param as array of strings (see ([documentation](https://uploadcare.com/docs/transformations/video_encoding/#process-url-formatting?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift))):
417
+
Alternatively, you can pass custom "paths" param as array of strings (see ([documentation](https://uploadcare.com/docs/transformations/video_encoding/#process-url-formatting))):
418
418
419
419
```swift
420
420
uploadcare.convertVideos([":uuid/video/-/format/ogg/"]) { response, error in
@@ -427,7 +427,7 @@ uploadcare.convertVideos([":uuid/video/-/format/ogg/"]) { response, error in
427
427
}
428
428
```
429
429
430
-
## Video conversion job status ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/videoConvertStatus?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
430
+
## Video conversion job status ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/videoConvertStatus)) ##
431
431
432
432
```swift
433
433
uploadcare.videoConversionJobStatus(token: 123456) { job, error in
Copy file name to clipboardexpand all lines: Documentation/Upload API.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ task.cancel()
46
46
(task as? UploadTaskResumable)?.resume()
47
47
```
48
48
49
-
## Direct uploads ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/baseUpload/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
49
+
## Direct uploads ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/baseUpload/)) ##
50
50
51
51
Direct uploads work with background URLSession, so uploading will continue if the app goes to the background state. It support files smaller than 100MB only
52
52
@@ -72,7 +72,7 @@ let task = uploadcare.uploadAPI.directUpload(files: ["random_file_name.jpg": da
Multipart Uploads are useful when you are dealing with files larger than 100MB or you explicitly want to accelerate uploads. Each Multipart Upload contains 3 steps:
78
78
1. Start transaction
@@ -105,7 +105,7 @@ task.pause()
105
105
task.resume()
106
106
```
107
107
108
-
## Upload files from URLs ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/fromURLUpload/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
108
+
## Upload files from URLs ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/fromURLUpload/)) ##
@@ -135,7 +135,7 @@ uploadcare.uploadAPI.upload(task: task1) { result, error in
135
135
}
136
136
```
137
137
138
-
## Check the status of a file uploaded from URL ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/fromURLUploadStatus/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
138
+
## Check the status of a file uploaded from URL ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/fromURLUploadStatus/)) ##
139
139
140
140
Use a token recieved with Upload files from the URLs method:
141
141
@@ -149,7 +149,7 @@ uploadcare.uploadAPI.uploadStatus(forToken: "UPLOAD_TOKEN") { status, error in
149
149
}
150
150
```
151
151
152
-
## File info ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/fileUploadInfo/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
152
+
## File info ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/fileUploadInfo/)) ##
153
153
154
154
```swift
155
155
uploadcare.uploadAPI.fileInfo(withFileId: "FILE_UUID") { file, error in
@@ -161,7 +161,7 @@ uploadcare.uploadAPI.fileInfo(withFileId: "FILE_UUID") { file, error in
161
161
}
162
162
```
163
163
164
-
## Create file group ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/createFilesGroup/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
164
+
## Create file group ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/createFilesGroup/)) ##
165
165
166
166
Uploadcare library provides 2 methods to create a group:
167
167
@@ -191,7 +191,7 @@ uploadcare.uploadAPI.createFilesGroup(fileIds: filesIds) { response, error in
191
191
}
192
192
```
193
193
194
-
## Files group info ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/filesGroupInfo/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
194
+
## Files group info ([API Reference](https://uploadcare.com/api-refs/upload-api/#operation/filesGroupInfo/)) ##
195
195
196
196
```swift
197
197
uploadcare.uploadAPI.filesGroupInfo(groupId: "FILES_GROUP_ID") { group, error in
@@ -203,7 +203,7 @@ uploadcare.uploadAPI.filesGroupInfo(groupId: "FILES_GROUP_ID") { group, error in
Signing requests works by default if a Secret key is provided during SDK initialization. SDK generates a signature internally, and this signature stays valid for 30 minutes. New signatures are generated automatically when older ones expire.
0 commit comments