Projet

Général

Profil

Pelle API v10 » Historique » Version 31

Nicolas BERTRAND, 13/09/2016 17:14

1 1 Nicolas BERTRAND
h1. Pelle API v10
2 2 Nicolas BERTRAND
3 22 Nicolas BERTRAND
This document describes the REST API interface to control distribution of DCPs for "Indé-CP":http://www.indecp.org .
4 22 Nicolas BERTRAND
 
5 24 Nicolas BERTRAND
The distribution is managed via the tuco:http://tuco.tdcpb.org
6 24 Nicolas BERTRAND
7 24 Nicolas BERTRAND
Basically this API provides services  
8 22 Nicolas BERTRAND
9 2 Nicolas BERTRAND
h2. API Base URL
10 3 Nicolas BERTRAND
11 23 Nicolas BERTRAND
All URLs in the reference documentation use the following base URL:
12 2 Nicolas BERTRAND
<pre>
13 2 Nicolas BERTRAND
https://tuco.tdcpb.org/pelle/v1.0
14 1 Nicolas BERTRAND
</pre>
15 23 Nicolas BERTRAND
16 2 Nicolas BERTRAND
17 2 Nicolas BERTRAND
h2. Authentication
18 2 Nicolas BERTRAND
19 2 Nicolas BERTRAND
HTTP requests to the REST API are protected with HTTP Basic authentication 
20 2 Nicolas BERTRAND
21 2 Nicolas BERTRAND
Example:
22 2 Nicolas BERTRAND
<pre>
23 2 Nicolas BERTRAND
curl -u <username>:<pass> -H "Content-Type: application/json" -X GET https://tuco.tdcpb.org/pelle/v1.0/exhibitors
24 2 Nicolas BERTRAND
</pre>
25 4 Nicolas BERTRAND
26 9 Nicolas BERTRAND
h2. Exhibitors Resources
27 4 Nicolas BERTRAND
28 6 Nicolas BERTRAND
h3. Exhibitor Properties
29 8 Nicolas BERTRAND
30 8 Nicolas BERTRAND
|_. NAME |_. DESCRIPTION |
31 7 Nicolas BERTRAND
| cncid | Unique exhibitor authorization ID given by CNC |
32 7 Nicolas BERTRAND
| id |  Unique ID given by tuco (internal usage) |
33 7 Nicolas BERTRAND
| name | Theater name |
34 7 Nicolas BERTRAND
| address |  Exhibitor address |
35 7 Nicolas BERTRAND
| city |  Exhibitor city |
36 7 Nicolas BERTRAND
| contact |  Person to contact |
37 1 Nicolas BERTRAND
38 7 Nicolas BERTRAND
 
39 6 Nicolas BERTRAND
40 5 Nicolas BERTRAND
41 4 Nicolas BERTRAND
h3. List all exhibitors
42 4 Nicolas BERTRAND
43 4 Nicolas BERTRAND
<pre>
44 4 Nicolas BERTRAND
GET exhibitors
45 4 Nicolas BERTRAND
</pre>
46 4 Nicolas BERTRAND
47 9 Nicolas BERTRAND
Output sample:
48 1 Nicolas BERTRAND
49 1 Nicolas BERTRAND
<pre>
50 1 Nicolas BERTRAND
{
51 5 Nicolas BERTRAND
  exhibitors:[
52 5 Nicolas BERTRAND
  {
53 1 Nicolas BERTRAND
    'cncid': '123456',
54 9 Nicolas BERTRAND
    'name': 'UN CINEMA'
55 1 Nicolas BERTRAND
    'city' : LA VILLE
56 9 Nicolas BERTRAND
  },
57 9 Nicolas BERTRAND
....
58 1 Nicolas BERTRAND
 ]
59 9 Nicolas BERTRAND
}
60 9 Nicolas BERTRAND
</pre>
61 9 Nicolas BERTRAND
62 9 Nicolas BERTRAND
h3. Retrieve a exhibitor
63 9 Nicolas BERTRAND
64 9 Nicolas BERTRAND
<pre>
65 9 Nicolas BERTRAND
GET exhibitors/<cncid>
66 9 Nicolas BERTRAND
</pre>
67 9 Nicolas BERTRAND
68 9 Nicolas BERTRAND
69 9 Nicolas BERTRAND
Output sample:
70 9 Nicolas BERTRAND
71 9 Nicolas BERTRAND
<pre>
72 9 Nicolas BERTRAND
{
73 9 Nicolas BERTRAND
  exhibitors:
74 9 Nicolas BERTRAND
  {
75 9 Nicolas BERTRAND
    'cncid': '123456',
76 9 Nicolas BERTRAND
    'name': 'UN CINEMA'
77 9 Nicolas BERTRAND
    'city' : LA VILLE
78 9 Nicolas BERTRAND
  },
79 4 Nicolas BERTRAND
}
80 4 Nicolas BERTRAND
</pre>
81 10 Nicolas BERTRAND
82 10 Nicolas BERTRAND
83 10 Nicolas BERTRAND
h3. Retrieve a exhibitor current downloads
84 10 Nicolas BERTRAND
85 10 Nicolas BERTRAND
86 10 Nicolas BERTRAND
<pre>
87 10 Nicolas BERTRAND
GET exhibitors/<cncid>/current_downloads
88 10 Nicolas BERTRAND
</pre>
89 10 Nicolas BERTRAND
90 10 Nicolas BERTRAND
91 10 Nicolas BERTRAND
Output sample:
92 10 Nicolas BERTRAND
<pre>
93 10 Nicolas BERTRAND
</pre>
94 11 Nicolas BERTRAND
95 11 Nicolas BERTRAND
96 11 Nicolas BERTRAND
97 11 Nicolas BERTRAND
h2. Distributor Resources
98 11 Nicolas BERTRAND
99 11 Nicolas BERTRAND
h3. Distributor Properties
100 26 Nicolas BERTRAND
101 25 Nicolas BERTRAND
|_. NAME |_. DESCRIPTION |
102 25 Nicolas BERTRAND
| cncid | Unique ID given by CNC |
103 25 Nicolas BERTRAND
| id |  Unique ID given by tuco (internal usage) |
104 28 Nicolas BERTRAND
| name | Distributor name |
105 25 Nicolas BERTRAND
106 28 Nicolas BERTRAND
107 11 Nicolas BERTRAND
h3. List all distributors
108 11 Nicolas BERTRAND
109 11 Nicolas BERTRAND
<pre>
110 11 Nicolas BERTRAND
GET distributors
111 11 Nicolas BERTRAND
</pre>
112 11 Nicolas BERTRAND
113 11 Nicolas BERTRAND
Output sample:
114 25 Nicolas BERTRAND
<pre>
115 25 Nicolas BERTRAND
{
116 25 Nicolas BERTRAND
    "distributors": [
117 27 Nicolas BERTRAND
       {
118 27 Nicolas BERTRAND
            "cncid": 1261, 
119 27 Nicolas BERTRAND
            "distributorid": 47, 
120 27 Nicolas BERTRAND
            "name": "LES FILMS DU LOSANGE"
121 25 Nicolas BERTRAND
        }, 
122 25 Nicolas BERTRAND
        {
123 27 Nicolas BERTRAND
            "cncid": 3133, 
124 27 Nicolas BERTRAND
            "distributorid": 41, 
125 27 Nicolas BERTRAND
            "name": "URBAN DISTRIBUTION"
126 27 Nicolas BERTRAND
        }, 
127 27 Nicolas BERTRAND
128 27 Nicolas BERTRAND
    ...
129 27 Nicolas BERTRAND
    ]
130 1 Nicolas BERTRAND
} 
131 1 Nicolas BERTRAND
</pre>
132 1 Nicolas BERTRAND
133 1 Nicolas BERTRAND
h3. Retrieve a distributor
134 1 Nicolas BERTRAND
135 1 Nicolas BERTRAND
<pre>
136 1 Nicolas BERTRAND
GET distributors/<cncid>
137 1 Nicolas BERTRAND
</pre>
138 25 Nicolas BERTRAND
139 27 Nicolas BERTRAND
Output sample
140 28 Nicolas BERTRAND
<pre>
141 27 Nicolas BERTRAND
{
142 27 Nicolas BERTRAND
    "distributor": {
143 27 Nicolas BERTRAND
        "cncid": 1261, 
144 27 Nicolas BERTRAND
        "distributorid": 47, 
145 27 Nicolas BERTRAND
        "name": "LES FILMS DU LOSANGE"
146 27 Nicolas BERTRAND
    }
147 27 Nicolas BERTRAND
}
148 28 Nicolas BERTRAND
</pre>
149 12 Nicolas BERTRAND
150 12 Nicolas BERTRAND
h3. List distributor catalog
151 30 Nicolas BERTRAND
152 31 Nicolas BERTRAND
*movies properties* 
153 30 Nicolas BERTRAND
154 30 Nicolas BERTRAND
|_. NAME |_. DESCRIPTION |
155 30 Nicolas BERTRAND
| movieid | |
156 30 Nicolas BERTRAND
| original_title |  Orginal movie title name (optional) |
157 30 Nicolas BERTRAND
| releasedate | First movie release date |
158 31 Nicolas BERTRAND
| title | Movie title |
159 30 Nicolas BERTRAND
| dcps  | list of DCPs properties  (cf DCP properties table)| 
160 30 Nicolas BERTRAND
161 31 Nicolas BERTRAND
*DCP properties* 
162 30 Nicolas BERTRAND
163 30 Nicolas BERTRAND
|_. NAME |_. DESCRIPTION |
164 30 Nicolas BERTRAND
| dcpid |  Unique ID given to a movie in tuco |
165 31 Nicolas BERTRAND
| contentkind | Type of content( FTR  TLR SHR) |
166 30 Nicolas BERTRAND
| name | DCP name |
167 30 Nicolas BERTRAND
| size | Size of DCP (in bytes) | 
168 30 Nicolas BERTRAND
169 30 Nicolas BERTRAND
170 12 Nicolas BERTRAND
<pre>
171 12 Nicolas BERTRAND
GET distributors/<cncid>/movies
172 12 Nicolas BERTRAND
</pre>
173 12 Nicolas BERTRAND
174 12 Nicolas BERTRAND
175 30 Nicolas BERTRAND
176 12 Nicolas BERTRAND
Output sample:
177 30 Nicolas BERTRAND
178 30 Nicolas BERTRAND
179 29 Nicolas BERTRAND
<pre>
180 29 Nicolas BERTRAND
{
181 29 Nicolas BERTRAND
    "movies": [ 
182 29 Nicolas BERTRAND
        {
183 29 Nicolas BERTRAND
            "dcps": [
184 29 Nicolas BERTRAND
                {
185 29 Nicolas BERTRAND
                    "contentkind": "FTR", 
186 29 Nicolas BERTRAND
                    "dcpid": 512, 
187 29 Nicolas BERTRAND
                    "name": "LeFilsDeJoseph_FTR_F_FR-FR_FR_51_2K_LOS_20160219_DGM_IOP_OV", 
188 29 Nicolas BERTRAND
                    "size": "207208283635"
189 29 Nicolas BERTRAND
                }
190 29 Nicolas BERTRAND
            ], 
191 29 Nicolas BERTRAND
            "movieid": 330, 
192 29 Nicolas BERTRAND
            "original_title": "", 
193 29 Nicolas BERTRAND
            "releasedate": "2016-04-20", 
194 29 Nicolas BERTRAND
            "title": "LE FILS DE JOSEPH"
195 29 Nicolas BERTRAND
        }, 
196 29 Nicolas BERTRAND
        {
197 29 Nicolas BERTRAND
            "dcps": [
198 29 Nicolas BERTRAND
                {
199 29 Nicolas BERTRAND
                    "contentkind": "FTR", 
200 29 Nicolas BERTRAND
                    "dcpid": 541, 
201 29 Nicolas BERTRAND
                    "name": "LAvenir_FTR_F_FR-FR_FR_51_2K_FDL_20160229_ECL_IOP_OV", 
202 29 Nicolas BERTRAND
                    "size": "186571642897"
203 29 Nicolas BERTRAND
                }, 
204 29 Nicolas BERTRAND
                {
205 29 Nicolas BERTRAND
                    "contentkind": "TLR", 
206 29 Nicolas BERTRAND
                    "dcpid": 543, 
207 29 Nicolas BERTRAND
                    "name": "LAvenir_TLR-P-Date_F_FR-XX_FR_51_2K_FDL_20160308_ECL_IOP_OV", 
208 29 Nicolas BERTRAND
                    "size": "3100055161"
209 29 Nicolas BERTRAND
                }
210 29 Nicolas BERTRAND
            ], 
211 29 Nicolas BERTRAND
            "movieid": 343, 
212 29 Nicolas BERTRAND
            "original_title": "", 
213 29 Nicolas BERTRAND
            "releasedate": "2016-04-06", 
214 29 Nicolas BERTRAND
            "title": "L'AVENIR"
215 29 Nicolas BERTRAND
        }, 
216 29 Nicolas BERTRAND
        {
217 29 Nicolas BERTRAND
            "dcps": [
218 29 Nicolas BERTRAND
                {
219 29 Nicolas BERTRAND
                    "contentkind": "TLR", 
220 29 Nicolas BERTRAND
                    "dcpid": 1049, 
221 29 Nicolas BERTRAND
                    "name": "ResterVertical_TLR_F_FR-XX_FR_51_2K_LOS_20160704_TST_IOP_OV", 
222 29 Nicolas BERTRAND
                    "size": "1438180164"
223 29 Nicolas BERTRAND
                }
224 29 Nicolas BERTRAND
            ], 
225 29 Nicolas BERTRAND
            "movieid": 430, 
226 29 Nicolas BERTRAND
            "original_title": "", 
227 29 Nicolas BERTRAND
            "releasedate": "2016-08-24", 
228 29 Nicolas BERTRAND
            "title": "RESTER VERTICAL"
229 29 Nicolas BERTRAND
        }
230 29 Nicolas BERTRAND
    ]
231 29 Nicolas BERTRAND
}
232 29 Nicolas BERTRAND
</pre>
233 29 Nicolas BERTRAND
234 12 Nicolas BERTRAND
235 13 Nicolas BERTRAND
236 13 Nicolas BERTRAND
h2. Distribution Resources
237 13 Nicolas BERTRAND
238 17 Nicolas BERTRAND
h3. properties
239 17 Nicolas BERTRAND
240 17 Nicolas BERTRAND
|_. NAME |_. DESCRIPTION |
241 17 Nicolas BERTRAND
| autorisation_date | Date of distribution autorisation |
242 17 Nicolas BERTRAND
| dcp | DCP name on distribution | 
243 17 Nicolas BERTRAND
| dcpid | Id of DCP on distribution |
244 17 Nicolas BERTRAND
| eta | Estimated Time of Accomplishment for DCP download in theater (available when _status_ is _Distribution started_ , _N/A_ else) |
245 18 Nicolas BERTRAND
| exhibitor | Exhibitor name |
246 18 Nicolas BERTRAND
| exhibitor_cncid |  Unique exhibitor authorization ID given by CNC |
247 18 Nicolas BERTRAND
| finished_transfer_date | Finished transfer to theater date |
248 18 Nicolas BERTRAND
| proress | DCP download progress in percent (available when _status_ is _Distribution started_ , _N/A_ else) |
249 18 Nicolas BERTRAND
| started_transfer_date |DCP download start date |
250 19 Nicolas BERTRAND
| status | Distribution status (cf. next table)|
251 17 Nicolas BERTRAND
252 17 Nicolas BERTRAND
253 19 Nicolas BERTRAND
*Distribution status states:*
254 1 Nicolas BERTRAND
255 1 Nicolas BERTRAND
|_. NAME |
256 19 Nicolas BERTRAND
| 'Distribution not allowed' |
257 19 Nicolas BERTRAND
| 'Distribution allowed' |
258 19 Nicolas BERTRAND
| 'Distribution started' |
259 19 Nicolas BERTRAND
| 'Distribution finished' |
260 19 Nicolas BERTRAND
| 'Distribution error' |
261 19 Nicolas BERTRAND
 
262 19 Nicolas BERTRAND
263 17 Nicolas BERTRAND
264 17 Nicolas BERTRAND
265 14 Nicolas BERTRAND
h3. Retrieve distribution status of DCP <dcpid> to exhibitor <cncid>
266 14 Nicolas BERTRAND
267 14 Nicolas BERTRAND
<pre>
268 14 Nicolas BERTRAND
GET distributions/<cncid>/<dcpid>
269 14 Nicolas BERTRAND
</pre>
270 14 Nicolas BERTRAND
271 16 Nicolas BERTRAND
Sample output
272 16 Nicolas BERTRAND
<pre>
273 16 Nicolas BERTRAND
{
274 16 Nicolas BERTRAND
    "distributions": {
275 16 Nicolas BERTRAND
        "autorisation_date": "2016-07-04T07:25:16", 
276 16 Nicolas BERTRAND
        "dcp": "HAUT-ET-COURT_TONI-ERDMANN_2K-F-185_51-DE_ST-FR_DCP-24-IOP-CPT_1606TVS7354", 
277 16 Nicolas BERTRAND
        "dcpid": 1024, 
278 16 Nicolas BERTRAND
        "eta": "N/A", 
279 16 Nicolas BERTRAND
        "exhibitor": "UTOPIA TOURNEFEUILLE", 
280 16 Nicolas BERTRAND
        "exhibitor_cncid": 431352, 
281 16 Nicolas BERTRAND
        "finished_transfer_date": "2016-07-08T11:30:55", 
282 16 Nicolas BERTRAND
        "progress": "N/A", 
283 16 Nicolas BERTRAND
        "started_transfer_date": "2016-07-04T13:29:07", 
284 16 Nicolas BERTRAND
        "status": "Distribution finished", 
285 16 Nicolas BERTRAND
        "statusId": 0
286 16 Nicolas BERTRAND
    }
287 16 Nicolas BERTRAND
}
288 16 Nicolas BERTRAND
</pre>
289 13 Nicolas BERTRAND
290 12 Nicolas BERTRAND
h3. Distribute a DCP to a distributor
291 12 Nicolas BERTRAND
292 12 Nicolas BERTRAND
<pre>
293 15 Nicolas BERTRAND
POST distributions
294 1 Nicolas BERTRAND
</pre>
295 15 Nicolas BERTRAND
296 15 Nicolas BERTRAND
Parameters
297 15 Nicolas BERTRAND
298 15 Nicolas BERTRAND
|_. NAME |_. DESCRIPTION |
299 15 Nicolas BERTRAND
| cncid | Unique exhibitor authorization ID given by CNC |
300 15 Nicolas BERTRAND
| dcpid | Id of DCP to distribute |
301 16 Nicolas BERTRAND
302 16 Nicolas BERTRAND
*Sample*
303 16 Nicolas BERTRAND
Distribute Toni Erdman FTR DCP (dcpid: 1024) to Utopia tournefeuille( cncid: 431352 )
304 21 Nicolas BERTRAND
_Input:_
305 16 Nicolas BERTRAND
<pre>
306 16 Nicolas BERTRAND
curl -H "Content-Type: application/json" \ 
307 16 Nicolas BERTRAND
-u username:password \
308 16 Nicolas BERTRAND
-X POST\
309 16 Nicolas BERTRAND
-d '{"cncid": "431352", "dcpid": "1024" }'\
310 16 Nicolas BERTRAND
-i https://tuco.tdcpb.org/pelle/v1.0/distributions
311 16 Nicolas BERTRAND
</pre>
312 21 Nicolas BERTRAND
_Output:_
313 20 Nicolas BERTRAND
<pre>
314 20 Nicolas BERTRAND
{
315 20 Nicolas BERTRAND
code 201 CREATED
316 20 Nicolas BERTRAND
{
317 20 Nicolas BERTRAND
    "distributions": {
318 20 Nicolas BERTRAND
        "autorisation_date": "2016-07-04T07:25:16", 
319 20 Nicolas BERTRAND
        "dcp": "HAUT-ET-COURT_TONI-ERDMANN_2K-F-185_51-DE_ST-FR_DCP-24-IOP-CPT_1606TVS7354", 
320 20 Nicolas BERTRAND
        "dcpid": 1024, 
321 20 Nicolas BERTRAND
        "eta": "N/A", 
322 20 Nicolas BERTRAND
        "exhibitor": "UTOPIA TOURNEFEUILLE", 
323 20 Nicolas BERTRAND
        "exhibitor_cncid": 431352, 
324 20 Nicolas BERTRAND
        "finished_transfer_date": "2016-07-08T11:30:55", 
325 20 Nicolas BERTRAND
        "progress": "N/A", 
326 20 Nicolas BERTRAND
        "started_transfer_date": "2016-07-04T13:29:07", 
327 20 Nicolas BERTRAND
        "status": "Distribution finished", 
328 20 Nicolas BERTRAND
    }
329 20 Nicolas BERTRAND
}
330 20 Nicolas BERTRAND
</pre>
331 20 Nicolas BERTRAND
332 20 Nicolas BERTRAND
h3. Delete a distribution instance
333 20 Nicolas BERTRAND
334 20 Nicolas BERTRAND
<pre>
335 20 Nicolas BERTRAND
DELETE distributions/<cncid>/<dcpid>
336 20 Nicolas BERTRAND
</pre>
337 20 Nicolas BERTRAND
338 20 Nicolas BERTRAND
*Sample*
339 20 Nicolas BERTRAND
Distribute Toni Erdman FTR DCP (dcpid: 1024) to Utopia tournefeuille( cncid: 431352 )
340 20 Nicolas BERTRAND
_Input_
341 20 Nicolas BERTRAND
<pre>
342 20 Nicolas BERTRAND
curl \ 
343 20 Nicolas BERTRAND
-u username:password \
344 20 Nicolas BERTRAND
-X DELETE\
345 20 Nicolas BERTRAND
-d '{"cncid": "431352", "dcpid": "1024" }'\
346 20 Nicolas BERTRAND
-i https://tuco.tdcpb.org/pelle/v1.0/distributions
347 20 Nicolas BERTRAND
</pre>
348 20 Nicolas BERTRAND
349 20 Nicolas BERTRAND
_Output_
350 20 Nicolas BERTRAND
<pre>
351 20 Nicolas BERTRAND
No output
352 20 Nicolas BERTRAND
code 204 NO CONTENT
353 20 Nicolas BERTRAND
</pre>