src/Wallabag/CoreBundle/Resources/views/themes/baggy/Developer/howto_app.html.twig

   1 {% extends "WallabagCoreBundle::layout.html.twig" %}
   2
   3 {% block title %}{% trans %}How to create my first application{% endtrans %}{% endblock %}
   4
   5 {% block css %}
   6     {{ parent() }}
   7     <link rel="stylesheet" href="{{ asset('bundles/wallabagcore/themes/_global/css/prism.css') }}">
   8 {% endblock %}
   9
  10 {% block content %}
  11 <div class="row">
  12     <div class="col s12">
  13         <div class="card-panel settings">
  14
  15             <div class="row">
  16                 <p>The following commands make use of the <a href="https://github.com/jkbrzt/httpie">HTTPie library</a>. Make sure it is installed on your system before using it.</p>
  17                 <p>You need a token to communicate between your 3rd application and wallabag API.</p>
  18                 <p>To create this token, you need <a href="{{ path('create_client') }}">to create a new client</a>.</p>
  19                 <p>Now, create your token (replace client_id, client_secret, username and password with the good values):</p>
  20                 <p>
  21                     <pre><code class="language-bash">http POST http://v2.wallabag.org/oauth/v2/token \
  22     grant_type=password \
  23     client_id=12_5um6nz50ceg4088c0840wwc0kgg44g00kk84og044ggkscso0k \
  24     client_secret=3qd12zpeaxes8cwg8c0404g888co4wo8kc4gcw0occww8cgw4k \
  25     username=yourUsername \
  26     password=yourPassw0rd</code></pre>
  27                 </p>
  28                 <p>The API will return a response like this:</p>
  29                 <p>
  30                     <pre><code class="language-bash">HTTP/1.1 200 OK
  31 Cache-Control: no-store, private
  32 Connection: close
  33 Content-Type: application/json
  34 Date: Tue, 06 Oct 2015 18:24:03 GMT
  35 Host: localhost:8000
  36 Pragma: no-cache
  37 X-Debug-Token: be00a1
  38 X-Debug-Token-Link: /profiler/be00a1
  39 X-Powered-By: PHP/5.5.9-1ubuntu4.13
  40 {
  41     "access_token": "ZWFjNjA3ZWMwYWVmYzRkYTBlMmQ3NTllYmVhOGJiZDE0ZTg1NjE4MjczOTVlNzM0ZTRlMWQ0MmRlMmYwNTk5Mw",
  42     "expires_in": 3600,
  43     "refresh_token": "ODBjODU1NWUwNmUzZTBkNDQ5YWVlZTVlMjQ2Y2I0OWM2NTM1ZGM2M2Y3MDhjMTViM2U2MzYxYzRkMDk5ODRlZg",
  44     "scope": null,
  45     "token_type": "bearer"
  46 }</code></pre>
  47                 </p>
  48                 <p>The access_token is useful to do a call to the API endpoint. For example:</p>
  49                 <p>
  50                     <pre><code class="language-bash">http GET http://v2.wallabag.org/api/entries.json \
  51     "Authorization:Bearer ZWFjNjA3ZWMwYWVmYzRkYTBlMmQ3NTllYmVhOGJiZDE0ZTg1NjE4MjczOTVlNzM0ZTRlMWQ0MmRlMmYwNTk5Mw"</code></pre>
  52                 </p>
  53                 <p>This call will return all the entries for your user.</p>
  54                 <p>If you want to see all the API endpoints, you can have a look <a href="{{ path('nelmio_api_doc_index') }}">to our API documentation</a>.</p>
  55                 <p><a href="{{ path('developer') }}" class="waves-effect waves-light grey btn">{% trans %}Back{% endtrans %}</a></p>
  56             </div>
  57
  58         </div>
  59     </div>
  60 </div>
  61     <script src="{{ asset('bundles/wallabagcore/themes/_global/js/prism.js') }}"></script>
  62 {% endblock %}