Skip to content

Commit 4986d7c

Browse files
rsedykhrsedykh
committed
Update docs and readme
1 parent 760c7de commit 4986d7c

File tree

3 files changed

+129
-214
lines changed

3 files changed

+129
-214
lines changed

‎Documentation/REST API.md

+73-69
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,31 @@
11
# REST API
22

33
* [Initialization](#initialization)
4-
* [Getting info about account project](#getting-info-about-account-project-api-reference)
5-
* [Get list of files](#get-list-of-files-api-reference)
4+
* [List of files](#list-of-files-api-reference)
65
* [File info](#file-info-api-reference)
7-
* [Delete files](#delete-files-api-reference)
86
* [Store files](#store-files-api-reference)
9-
* [Get list of groups](#get-list-of-groups-api-reference)
10-
* [Group info](#group-info-api-reference)
11-
* [Store group](#store-group-api-reference)
7+
* [Delete files](#delete-files-api-reference)
128
* [Copy file to local storage](#copy-file-to-local-storage-api-reference)
139
* [Copy file to remote storage](#copy-file-to-remote-storage-api-reference)
14-
* [Authenticated URLs](#authenticated-urls-api-reference)
15-
10+
* [List of groups](#list-of-groups-api-reference)
11+
* [Group info](#group-info-api-reference)
12+
* [Store group](#store-group-api-reference)
13+
* [Project info](#project-info-api-reference)
14+
* [Secure delivery](secure-delivery-api-reference)
1615

17-
### Initialization
1816

19-
REST API requires both public and secret key:
20-
```swift
21-
let uploadcare = Uploadcare(withPublicKey: "YOUR_PUBLIC_KEY", secretKey: "YOUR_SECRET_KEY")
22-
```
17+
## Initialization
2318

24-
### Getting info about account project ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/projectInfo?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ###
19+
REST API requires both public and secret keys:
2520

2621
```swift
27-
uploadcare.getProjectInfo { (project, error) in
28-
if let error = error {
29-
print(error)
30-
return
31-
}
32-
print(project ?? "")
33-
}
22+
let uploadcare = Uploadcare(withPublicKey: "YOUR_PUBLIC_KEY", secretKey: "YOUR_SECRET_KEY")
3423
```
3524

36-
### Get 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)) ###
25+
## 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)) ##
3726

3827
```swift
39-
// Make query object
28+
// Make a query object
4029
let query = PaginationQuery()
4130
.stored(true)
4231
.ordering(.sizeDESC)
@@ -54,11 +43,13 @@ filesList.get(withQuery: query) { (list, error) in
5443
print(list ?? "")
5544
}
5645
```
46+
5747
Get next page:
48+
5849
```swift
59-
// check if next page is available
50+
// Check if the next page is available
6051
guard filesList.next != nil else { return }
61-
// get next page
52+
// Get the next page
6253
filesList.nextPage { (list, error) in
6354
if let error = error {
6455
print(error)
@@ -69,10 +60,11 @@ filesList.nextPage { (list, error) in
6960
```
7061

7162
Get previous page:
63+
7264
```swift
73-
// check if previous page is available
65+
// Check if the previous page is available
7466
guard filesList.previous != nil else { return }
75-
// get next page
67+
// Get the previous page
7668
filesList.previousPage { (list, error) in
7769
if let error = error {
7870
print(error)
@@ -82,7 +74,7 @@ filesList.previousPage { (list, error) in
8274
}
8375
```
8476

85-
### 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)) ###
77+
## 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)) ##
8678

8779
```swift
8880
uploadcare.fileInfo(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, error) in
@@ -94,9 +86,37 @@ uploadcare.fileInfo(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, e
9486
}
9587
```
9688

97-
### Delete files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/deleteFile?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ###
89+
## 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)) ##
90+
91+
Store an individual file:
92+
93+
```swift
94+
uploadcare.storeFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, error) in
95+
if let error = error {
96+
print(error)
97+
return
98+
}
99+
print(file ?? "")
100+
}
101+
```
102+
103+
Batch file storing:
104+
105+
```swift
106+
let uuids = ["b7a301d1-1bd0-473d-8d32-708dd55addc0", "1bac376c-aa7e-4356-861b-dd2657b5bfd2"]
107+
uploadcare.storeFiles(withUUIDs: uuids) { (response, error) in
108+
if let error = error {
109+
print(error)
110+
return
111+
}
112+
print(response ?? "")
113+
}
114+
```
115+
116+
## Delete files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/deleteFile?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
117+
118+
Delete an individual file:
98119

99-
Delete individual file:
100120
```swift
101121
uploadcare.deleteFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, error) in
102122
if let error = error {
@@ -108,6 +128,7 @@ uploadcare.deleteFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file,
108128
```
109129

110130
Batch file delete:
131+
111132
```swift
112133
let uuids = ["b7a301d1-1bd0-473d-8d32-708dd55addc0", "1bac376c-aa7e-4356-861b-dd2657b5bfd2"]
113134
uploadcare.deleteFiles(withUUIDs: uuids) { (response, error) in
@@ -119,23 +140,23 @@ uploadcare.deleteFiles(withUUIDs: uuids) { (response, error) in
119140
}
120141
```
121142

122-
### 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)) ###
143+
## 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)) ##
123144

124-
Store individual file:
125145
```swift
126-
uploadcare.storeFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, error) in
146+
uploadcare.copyFileToLocalStorage(source: "6ca619a8-70a7-4777-8de1-7d07739ebbd9") { (response, error) in
127147
if let error = error {
128148
print(error)
129149
return
130150
}
131-
print(file ?? "")
151+
print(response ?? "")
132152
}
133153
```
134154

135-
Batch file storing:
155+
## 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)) ##
156+
136157
```swift
137-
let uuids = ["b7a301d1-1bd0-473d-8d32-708dd55addc0", "1bac376c-aa7e-4356-861b-dd2657b5bfd2"]
138-
uploadcare.storeFiles(withUUIDs: uuids) { (response, error) in
158+
let source = "99c48392-46ab-4877-a6e1-e2557b011176"
159+
uploadcare.copyFileToRemoteStorage(source: source, target: "one_more_project", makePublic: true, pattern: .uuid) { (response, error) in
139160
if let error = error {
140161
print(error)
141162
return
@@ -144,7 +165,7 @@ uploadcare.storeFiles(withUUIDs: uuids) { (response, error) in
144165
}
145166
```
146167

147-
### Get 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)) ###
168+
## 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)) ##
148169

149170
```swift
150171
let query = GroupsListQuery()
@@ -159,7 +180,7 @@ uploadcare.listOfGroups(withQuery: query) { (list, error) in
159180
print(list ?? "")
160181
}
161182

162-
// using GroupsList object:
183+
// Using GroupsList object
163184
let groupsList = uploadcare.listOfGroups()
164185

165186
groupsList.get(withQuery: query) { (list, error) in
@@ -170,14 +191,14 @@ groupsList.get(withQuery: query) { (list, error) in
170191
print(list ?? "")
171192
}
172193

173-
// get next page
194+
// Get the next page
174195
groupsList.nextPage { (list, error) in
175196
if let error = error {
176197
print(error)
177198
return
178199
}
179200
}
180-
// get previous page
201+
// Get the previous page
181202
groupsList.previousPage { (list, error) in
182203
if let error = error {
183204
print(error)
@@ -187,7 +208,7 @@ groupsList.previousPage { (list, error) in
187208
}
188209
```
189210

190-
### 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)) ###
211+
## 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)) ##
191212

192213
```swift
193214
uploadcare.groupInfo(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (group, error) in
@@ -199,7 +220,7 @@ uploadcare.groupInfo(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (grou
199220
}
200221
```
201222

202-
### 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)) ###
223+
## 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)) ##
203224

204225
```swift
205226
uploadcare.storeGroup(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (error) in
@@ -211,51 +232,34 @@ uploadcare.storeGroup(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (err
211232
}
212233
```
213234

214-
### 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)) ###
235+
## Project info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/projectInfo?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
215236

216237
```swift
217-
uploadcare.copyFileToLocalStorage(source: "6ca619a8-70a7-4777-8de1-7d07739ebbd9") { (response, error) in
218-
if let error = error {
219-
print(error)
220-
return
221-
}
222-
print(response ?? "")
223-
}
224-
```
225-
226-
### 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)) ###
227-
228-
```swift
229-
let source = "99c48392-46ab-4877-a6e1-e2557b011176"
230-
uploadcare.copyFileToRemoteStorage(source: source, target: "one_more_project", makePublic: true, pattern: .uuid) { (response, error) in
238+
uploadcare.getProjectInfo { (project, error) in
231239
if let error = error {
232240
print(error)
233241
return
234242
}
235-
print(response ?? "")
243+
print(project ?? "")
236244
}
237245
```
238246

239-
### Authenticated URLs ([API Reference](https://uploadcare.com/docs/delivery/file_api/#authenticated-urls?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ###
247+
## Secure delivery ([API Reference](https://uploadcare.com/docs/delivery/file_api/#authenticated-urls?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
240248

241-
This method allows you to get an authenticated URL from your backend using a redirect.
242-
To answer a request to that URL your backend should generate an authenticated URL to your file and perform REDIRECT to a generated URL.
249+
This method allows you to get an authenticated URL from your backend by using a redirect.
250+
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.
243251

244-
A redirected URL will be caught and returned in the completion handler of that method.
252+
Example: https://yourdomain.com/{UUID}/ — backend redirects to https://cdn.yourdomain.com/{uuid}/?token={token}&expire={timestamp}.
245253

246-
Example: https://yourdomain.com/{UUID}/
247-
248-
Backend redirects to: https://cdn.yourdomain.com/{uuid}/?token={token}&expire={timestamp}
249-
250254
```swift
251255
let url = URL(string: "https://yourdomain.com/FILE_UUID/")!
252256
uploadcare.getAuthenticatedUrlFromUrl(url, { (value, error) in
253257
if let error = error {
254258
print(error)
255259
return
256260
}
257-
258-
// value is https://cdn.yourdomain.com/{uuid}/?token={token}&expire={timestamp}
261+
262+
// Value is https://cdn.yourdomain.com/{uuid}/?token={token}&expire={timestamp}
259263
print(value)
260264
})
261265
```

0 commit comments

Comments
 (0)