src/Wallabag/CoreBundle/Resources/views/themes/material/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 content %}
   6 <div class="row">
   7     <div class="col s12">
   8         <div class="card-panel settings">
   9
  10             <div class="row">
  11                 <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>
  12                 <p>You need a token to communicate between your 3rd application and wallabag API.</p>
  13                 <p>To create this token, you need <a href="{{ path('create_client') }}">to create a new client</a>.</p>
  14                 <p>Now, create your token (replace client_id, client_secret, username and password with the good values):</p>
  15                 <p>
  16                     <code>
  17                         <pre>
  18 http POST http://v2.wallabag.org/oauth/v2/token \
  19     grant_type=password \
  20     client_id=12_5um6nz50ceg4088c0840wwc0kgg44g00kk84og044ggkscso0k \
  21     client_secret=3qd12zpeaxes8cwg8c0404g888co4wo8kc4gcw0occww8cgw4k \
  22     username=yourUsername \
  23     password=yourPassw0rd
  24                         </pre>
  25                     </code>
  26                 </p>
  27                 <p>The API will return a response like this:</p>
  28                 <p>
  29                     <code>
  30                         <pre>
  31 HTTP/1.1 200 OK
  32 Cache-Control: no-store, private
  33 Connection: close
  34 Content-Type: application/json
  35 Date: Tue, 06 Oct 2015 18:24:03 GMT
  36 Host: localhost:8000
  37 Pragma: no-cache
  38 X-Debug-Token: be00a1
  39 X-Debug-Token-Link: /profiler/be00a1
  40 X-Powered-By: PHP/5.5.9-1ubuntu4.13
  41 {
  42     "access_token": "ZWFjNjA3ZWMwYWVmYzRkYTBlMmQ3NTllYmVhOGJiZDE0ZTg1NjE4MjczOTVlNzM0ZTRlMWQ0MmRlMmYwNTk5Mw",
  43     "expires_in": 3600,
  44     "refresh_token": "ODBjODU1NWUwNmUzZTBkNDQ5YWVlZTVlMjQ2Y2I0OWM2NTM1ZGM2M2Y3MDhjMTViM2U2MzYxYzRkMDk5ODRlZg",
  45     "scope": null,
  46     "token_type": "bearer"
  47 }
  48                         </pre>
  49                     </code>
  50                 </p>
  51                 <p>The access_token is useful to do a call to the API endpoint. For example:</p>
  52                 <p>
  53                     <code>
  54                         <pre>
  55 http GET http://v2.wallabag.org/api/entries.json \
  56     "Authorization:Bearer ZWFjNjA3ZWMwYWVmYzRkYTBlMmQ3NTllYmVhOGJiZDE0ZTg1NjE4MjczOTVlNzM0ZTRlMWQ0MmRlMmYwNTk5Mw"
  57                         </pre>
  58                     </code>
  59                 </p>
  60                 <p>This call will return all the entries for your user.</p>
  61                 <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>
  62                 <p><a class="waves-effect waves-light btn" href="{{ path('developer') }}">Back to Developer main page</a></p>
  63             </div>
  64
  65         </div>
  66     </div>
  67 </div>
  68 {% endblock %}