5 |
5 |
<div class="api-access-view">
|
6 |
6 |
<div class="subsection">
|
7 |
7 |
{% block page.body.title %}
|
8 |
|
<h2>API ACCESS</h2>
|
|
8 |
<h2>API ACCESS</h2>
|
9 |
9 |
{% endblock %}
|
10 |
10 |
{% block page.body.description %}
|
11 |
|
<p>
|
12 |
|
{{ BRANDING_SERVICE_NAME }} provides a complete REST API that allows you to access and
|
|
11 |
<div class="two-cols dotted clearfix">
|
|
12 |
<div class="rt">
|
|
13 |
<p>
|
|
14 |
If
|
|
15 |
you want to learn more about the specification of the REST API itself,
|
|
16 |
please take a look at the <a href="https://www.synnefo.org/docs"
|
|
17 |
alt="Synnefo documentation">Synnefo documentation</a>.
|
|
18 |
</p>
|
|
19 |
</div>
|
|
20 |
<div class="lt">
|
|
21 |
<p>{{ BRANDING_SERVICE_NAME }} provides a complete REST API that allows you to access and
|
13 |
22 |
control your virtual resources programmatically. This means you can execute
|
14 |
23 |
all the actions you do from the {{ BRANDING_SERVICE_NAME }} Web UI by using a command
|
15 |
|
line client or importing the corresponding library inside your own code. If
|
16 |
|
you want to learn more about the specification of the REST API itself,
|
17 |
|
please take a look at the <a href="https://www.synnefo.org/docs"
|
18 |
|
alt="Synnefo documentation">Synnefo documentation</a>.
|
19 |
|
</p>
|
|
24 |
line client or importing the corresponding library inside your own code.</p>
|
|
25 |
</div>
|
|
26 |
|
|
27 |
</div>
|
|
28 |
|
20 |
29 |
{% endblock %}
|
21 |
30 |
</div>
|
22 |
31 |
|
23 |
|
<div class="subsection">
|
|
32 |
<div class="subsection dotted">
|
24 |
33 |
{% block page.body.token %}
|
25 |
|
<h2>API details</h2>
|
26 |
|
<p>
|
|
34 |
<h2>API details</h2>
|
|
35 |
<p>
|
27 |
36 |
To use {{ BRANDING_SERVICE_NAME }} via its REST API the only things you will need is your
|
28 |
37 |
Authentication Token and the Identity Service's public URL, which you can
|
29 |
|
find right below.
|
30 |
|
<br />
|
31 |
|
<br />
|
32 |
|
</p>
|
33 |
|
<div class="token-view">
|
34 |
|
<div class="detail small clearfix">
|
35 |
|
<span class="title">Authentication url</span>
|
36 |
|
<input type="text" value="{{ token_url }}" disabled />
|
37 |
|
</div>
|
38 |
|
<div class="detail clearfix">
|
39 |
|
<span class="title">API Token</span>
|
40 |
|
<input type="text" value="{{ request.user.auth_token }}" disabled />
|
41 |
|
<span class="expires">
|
42 |
|
<span class="date">
|
43 |
|
expires in {{ request.user.auth_token_expires|timeuntil }}
|
44 |
|
({{ request.user.auth_token_expires|date }})
|
45 |
|
</span>
|
46 |
|
</span>
|
47 |
|
<span class="extra-img" id="token-span"> </span>
|
|
38 |
find right below.<br /><br />
|
|
39 |
</p>
|
|
40 |
<div class="token-view">
|
|
41 |
<div class="detail small clearfix">
|
|
42 |
<span class="title">Authentication url</span>
|
|
43 |
<input type="text" value="{{ token_url }}" disabled />
|
|
44 |
</div>
|
|
45 |
<div class="detail clearfix">
|
|
46 |
<div class="facts">
|
|
47 |
<span class="title">API Token</span>
|
|
48 |
<input type="text" value="{{ request.user.auth_token }}" disabled />
|
|
49 |
<span class="expires">
|
|
50 |
<span class="date">
|
|
51 |
expires in {{ request.user.auth_token_expires|timeuntil }}
|
|
52 |
({{ request.user.auth_token_expires|date }})
|
|
53 |
</span>
|
|
54 |
</span>
|
|
55 |
</div>
|
|
56 |
<div class="actions">
|
|
57 |
<div class="renew-token">
|
|
58 |
<a href="#" class="do">renew token</a>
|
|
59 |
<a href="#" class="confirm">confirm</a>
|
|
60 |
<a href="#" class="close">x</a>
|
|
61 |
<p class="sub">Make sure to set the new token in any client<br> you may be using each
|
|
62 |
time you renew your token.</p>
|
|
63 |
</div>
|
|
64 |
</div>
|
|
65 |
|
|
66 |
|
|
67 |
<span class="extra-img" id="token-span"> </span>
|
|
68 |
</div>
|
|
69 |
|
48 |
70 |
</div>
|
49 |
|
<p class="sub">Make sure to set the new token in any client you may be using each
|
50 |
|
time you renew your token.</p>
|
|
71 |
{% endblock %}
|
51 |
72 |
</div>
|
52 |
|
{% endblock %}
|
53 |
|
</div>
|
54 |
73 |
|
55 |
|
<div class="subsection api-clients">
|
56 |
|
{% block page.body.clients %}
|
57 |
|
<h2>Kamaki</h2>
|
58 |
|
<p>
|
59 |
|
<a href="{{ client_url }}" alt="kamaki">Kamaki</a> is the official
|
|
74 |
|
|
75 |
|
|
76 |
<div class="two-cols dotted clearfix">
|
|
77 |
<div class="rt">
|
|
78 |
{% block page.body.api_advanced %}
|
|
79 |
<h2>API Advanced Usage</h2>
|
|
80 |
<p>
|
|
81 |
Apart from using the kamaki command line client, you can also import the
|
|
82 |
kamaki library inside your code and use it directly. More details on how
|
|
83 |
to do that on the corresponding kamaki
|
|
84 |
<a href="{{ client_url }}">kamaki </a>page.</p>
|
|
85 |
<p>You can also implement the REST API calls by yourself, without
|
|
86 |
using the official kamaki library if you feel confident with your
|
|
87 |
programming skills. To do so, you first need to get a good grasp of the
|
|
88 |
API itself; for more information take a look at the corresponding page
|
|
89 |
inside the
|
|
90 |
<a href="https://synnefo.org/docs/">Synnefo documentation</a>.
|
|
91 |
</p>
|
|
92 |
{% endblock %}
|
|
93 |
</div>
|
|
94 |
<div class="lt">
|
|
95 |
{% block page.body.clients %}
|
|
96 |
<h2>Kamaki</h2>
|
|
97 |
<p><a href="{{ client_url }}" alt="kamaki">Kamaki</a> is the official
|
60 |
98 |
{{ BRANDING_SERVICE_NAME }} command line client. You can use it to control your virtual
|
61 |
|
resources from the command line or use it inside your scripts. Kamaki allows
|
62 |
|
you to execute all the operations you do from the Web UI. You can use kamaki
|
63 |
|
to register images, spawn clusters of customized VMs, connect them to
|
64 |
|
Private Virtual Networks, have them executing computations dynamically and
|
65 |
|
many other neat things. Kamaki is available for most Linux distributions,
|
|
99 |
resources from the command line or use it inside your scripts.</p>
|
|
100 |
<p>Kamaki allows you to execute all the operations you do from the Web UI. You can use kamaki to<br><br>
|
|
101 |
- register images,<br>- spawn clusters of customized VMs,<br>- connect them to
|
|
102 |
Private Virtual Networks,<br>- have them executing computations dynamically and
|
|
103 |
many other neat things.</p>
|
|
104 |
<p> Kamaki is available for most Linux distributions,
|
66 |
105 |
Windows and Mac OS X. To use it you will need to set it up using your
|
67 |
106 |
Authentication Token and the Identity Service's public URL, found above. To
|
68 |
107 |
learn more about kamaki and how to install, configure and use, take a look
|
69 |
|
at its <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">corresponding page</a> </p>
|
70 |
|
|
71 |
|
<p class="download">You can download kamaki
|
|
108 |
at its <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">corresponding page</a>
|
|
109 |
</p>
|
|
110 |
<p class="download">You can download kamaki
|
72 |
111 |
from the <a href="{{ client_url }}">project homepage</a></p>
|
73 |
|
{% endblock %}
|
74 |
|
</div>
|
75 |
|
|
76 |
|
<div class="subsection api-advanced">
|
77 |
|
{% block page.body.api_advanced %}
|
78 |
|
<h2>API Advanced Usage</h2>
|
79 |
|
<p>
|
80 |
|
Apart from using the kamaki command line client, you can also import the
|
81 |
|
kamaki library inside your code and use it directly. More details on how
|
82 |
|
to do that on the corresponding kamaki
|
83 |
|
<a href="{{ client_url }}">kamaki </a>page.
|
84 |
|
You can also implement the REST API calls by yourself, without
|
85 |
|
using the official kamaki library if you feel confident with your
|
86 |
|
programming skills. To do so, you first need to get a good grasp of the
|
87 |
|
API itself; for more information take a look at the corresponding page
|
88 |
|
inside the
|
89 |
|
<a href="https://synnefo.org/docs/">Synnefo documentation</a>.
|
90 |
|
</p>
|
91 |
|
{% endblock %}
|
|
112 |
|
|
113 |
</div>
|
|
114 |
{% endblock %}
|
92 |
115 |
</div>
|
93 |
116 |
</div>
|
94 |
|
</div>
|
95 |
117 |
{% endblock %}
|