Projet

Général

Profil

Pelle API v10 » Historique » Version 6

Nicolas BERTRAND, 07/09/2016 16:04

1 1 Nicolas BERTRAND
h1. Pelle API v10
2 2 Nicolas BERTRAND
3 2 Nicolas BERTRAND
h2. API Base URL
4 3 Nicolas BERTRAND
5 3 Nicolas BERTRAND
6 2 Nicolas BERTRAND
<pre>
7 2 Nicolas BERTRAND
https://tuco.tdcpb.org/pelle/v1.0
8 2 Nicolas BERTRAND
</pre>
9 2 Nicolas BERTRAND
10 2 Nicolas BERTRAND
h2. Authentication
11 2 Nicolas BERTRAND
12 2 Nicolas BERTRAND
HTTP requests to the REST API are protected with HTTP Basic authentication 
13 2 Nicolas BERTRAND
14 2 Nicolas BERTRAND
Example:
15 2 Nicolas BERTRAND
<pre>
16 2 Nicolas BERTRAND
curl -u <username>:<pass> -H "Content-Type: application/json" -X GET https://tuco.tdcpb.org/pelle/v1.0/exhibitors
17 2 Nicolas BERTRAND
</pre>
18 4 Nicolas BERTRAND
19 4 Nicolas BERTRAND
h2. Resources
20 4 Nicolas BERTRAND
21 6 Nicolas BERTRAND
h3. Exhibitor Properties
22 6 Nicolas BERTRAND
|_. NAME |_. DESCRIPTION|
23 6 Nicolas BERTRAND
| exh_cncid | Exhibitor authorization ID given by CNC |
24 1 Nicolas BERTRAND
25 6 Nicolas BERTRAND
26 5 Nicolas BERTRAND
27 4 Nicolas BERTRAND
h3. List all exhibitors
28 4 Nicolas BERTRAND
29 4 Nicolas BERTRAND
<pre>
30 4 Nicolas BERTRAND
GET exhibitors
31 4 Nicolas BERTRAND
</pre>
32 4 Nicolas BERTRAND
33 4 Nicolas BERTRAND
sample:
34 1 Nicolas BERTRAND
35 1 Nicolas BERTRAND
<pre>
36 1 Nicolas BERTRAND
{
37 5 Nicolas BERTRAND
  exhibitors:[
38 5 Nicolas BERTRAND
  {
39 5 Nicolas BERTRAND
    'cncid': '123456',
40 5 Nicolas BERTRAND
    'exhibitor_name': 'UN CINEMA'
41 5 Nicolas BERTRAND
    'city' : LA VILLE
42 5 Nicolas BERTRAND
  }
43 5 Nicolas BERTRAND
 ]
44 4 Nicolas BERTRAND
}
45 4 Nicolas BERTRAND
</pre>