Revision 5836ccb9 snf-astakos-app/astakos/im/templates/im/api_access_base.html

b/snf-astakos-app/astakos/im/templates/im/api_access_base.html
4 4 
{% block headjs %}
5 5 
	{{ block.super }}
6 6 
    <script>
7 
      var CHANGE_TOKEN_URL = '{% url update_token %}';
7 
      var CHANGt_TOKEN_URL = '{% url update_token %}';
8 8 
    </script>
9 9 
{% endblock %}
10 10 

  		





  ......




  17
  17
  
    
    {% endblock %}


  		





  18
  18
  
    
        <p class="dotted">


  		





  19
  19
  
    
    To use {{ BRANDING_SERVICE_NAME }} via its REST API you will need the following Authentication URL


  		





  20
  
  
    
    and API token:<br /><br />


  		





  
  20
  
    
    and Token:<br /><br />


  		





  21
  21
  
    
        </p>


  		





  22
  22
  
    
    </div>


  		





  23
  23
  
    
    <div class="subsection dotted">


  		





  ......




  32
  32
  
    
            </div>


  		





  33
  33
  
    
            <div class="detail clearfix">


  		





  34
  34
  
    
                <div class="facts clearfix">


  		





  35
  
  
    
                    <span class="title">API Token</span>


  		





  
  35
  
    
                    <span class="title">Token</span>


  		





  36
  36
  
    
                    <span id="dummy_auth_token" class="dummy-input">&nbsp;</span>


  		





  37
  37
  
    
                    <input value="{{ request.user.auth_token }}" type="text" name="auth_token" disabled/>


  		





  38
  38
  
    
                    <span class="expires">


  		





  ......




  70
  70
  
    
        <div class="two-cols dotted clearfix">


  		





  71
  71
  
    
            <div class="rt">


  		





  72
  72
  
    
                {% block page.body.api_advanced %}


  		





  73
  
  
    
                <h2>API Advanced Usage</h2>


  		





  
  73
  
    
                <h2>API advanced usage</h2>


  		





  74
  74
  
    
                <p>


  		





  75
  75
  
    
                Apart from using the kamaki command line client, you can also import the


  		





  76
  76
  
    
                kamaki library inside your code and use it directly. More details on how


  		





  77
  
  
    
                to do that on the corresponding kamaki 


  		





  78
  
  
    
                <a href="{{ client_url }}">kamaki </a>page.</p> 


  		





  
  77
  
    
                to do that on the corresponding  


  		





  
  78
  
    
                <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">kamaki </a>page.</p> 


  		





  79
  79
  
    
                <p>You can also implement the REST API calls by yourself, without


  		





  80
  80
  
    
                using the official kamaki library if you feel confident with your


  		





  81
  81
  
    
                programming skills. To do so, you first need to get a good grasp of the


  		





  82
  82
  
    
                API itself; for more information take a look at the corresponding page


  		





  83
  83
  
    
                inside the 


  		





  84
  
  
    
                <a href="https://synnefo.org/docs/">Synnefo documentation</a>.


  		





  
  84
  
    
                <a href="http://www.synnefo.org/docs">Synnefo documentation</a>.


  		





  85
  85
  
    
                </p>


  		





  86
  86
  
    
                {% endblock %}


  		





  87
  87
  
    
            </div>


  		





  88
  88
  
    
            <div class="lt">


  		





  89
  
  
    
                <h2>GENERAL</h2>


  		





  
  89
  
    
                <h2>General</h2>


  		





  90
  90
  
    
                <p>{{ BRANDING_SERVICE_NAME }} provides a complete REST API that allows you to access and


  		





  91
  91
  
    
    control your virtual resources programmatically. This means you can execute


  		





  92
  92
  
    
    all the actions you do from the {{ BRANDING_SERVICE_NAME }} Web UI by using a command


  		





  ......




  94
  94
  
    
    <p>


  		





  95
  95
  
    
                If


  		





  96
  96
  
    
                you want to learn more about the specification of the REST API itself,


  		





  97
  
  
    
                please take a look at the <a href="https://www.synnefo.org/docs" 


  		





  
  97
  
    
                please take a look at the <a href="http://www.synnefo.org/docs" 


  		





  98
  98
  
    
                alt="Synnefo documentation">Synnefo documentation</a>. 


  		





  99
  99
  
    
                </p>


  		





  100
  100
  
    
               


  		





  ......




  116
  116
  
    
password:  <span class="user-data">{{ user.auth_token }}</span></p>


  		





  117
  117
  
    

  		





  118
  118
  
    
<p>The username is your  {{ BRANDING_SERVICE_NAME }} user ID (UUID) and the password


  		





  119
  
  
    
is your authentication token. As you can see, its the same shown in the


  		





  
  119
  
    
is your Token. As you can see, its the same shown in the


  		





  120
  120
  
    
previous section. </p>


  		





  121
  121
  
    
        </div>


  		





  122
  122
  
    
        <div class="lt">


  		





  ......




  131
  131
  
    
    many other neat things.</p>


  		





  132
  132
  
    
            <p> Kamaki is available for most Linux distributions,


  		





  133
  133
  
    
    Windows and Mac OS X. To use it you will need to set it up using your


  		





  134
  
  
    
    Authentication Token and the Identity Service's public URL, found above. To


  		





  
  134
  
    
    Token and the Authentication URL, found above. To


  		





  135
  135
  
    
    learn more about kamaki and how to install, configure and use, take a look


  		





  136
  
  
    
    at its <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">corresponding page</a>


  		





  
  136
  
    
    at its <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">corresponding page</a>.


  		





  137
  137
  
    
            </p>


  		





  138
  138
  
    
             <p class="download">You can download kamaki 


  		





  139
  
  
    
    from the <a href="{{ client_url }}">project homepage</a></p>


  		





  
  139
  
    
    from the <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">project homepage</a>.</p>


  		





  140
  140
  
    
             <p>If you are using kamaki, you can download a pre-configured .kamakirc


  		





  141
  
  
    
file that contains your Authentication token and URL. Store this file


  		





  
  141
  
    
file that contains your Authentication URL and Token. Store this file


  		





  142
  142
  
    
under your home directory (~/.kamakirc) and kamaki will be able to


  		





  143
  143
  
    
access  {{ BRANDING_SERVICE_NAME }} automatically without the need of extra


  		





  144
  144
  
    
manual configuration.</p>


  		












Also available in:
  Unified diff