This repository has been archived by the owner on Feb 21, 2023. It is now read-only.
/
index.html
161 lines (146 loc) · 10.9 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Receive full resources instead of small - Flattr Developers</title>
<link rel="stylesheet" href="/styles/base.css">
<link rel="stylesheet" href="/styles/custom.css">
<link rel="stylesheet" href="/styles/syntax.css">
<link rel="shortcut icon" href="/favicon.ico">
</head>
<body>
<div class="container">
<h1><a href="/">Flattr Developer Platform</a></h1>
<ul class="nav">
<li>
<a href="/api">REST API</a>
<ul>
<li>
<span>Resources</span>
<ul>
<li><a href="/api/resources/flattrs">Flattrs</a></li>
<li><a href="/api/resources/things">Things</a></li>
<li><a href="/api/resources/users">Users</a></li>
<li><a href="/api/resources/activities">Activities</a></li>
<li><a href="/api/resources/categories">Categories</a></li>
<li><a href="/api/resources/languages">Languages</a></li>
</ul>
</li>
<li><a href="http://console.apihq.com/api/flattr" target="_blank">Console</a></li>
<li><a href="/api/changelog">Changelog</a></li>
<li><a href="/api/libraries">Clients</a></li>
<li><a href="/api/policy">Policy</a></li>
</ul>
</li>
<li><a href="/button">Embedded buttons</a></li>
<li><a href="/auto-submit">Auto-submit URL</a></li>
<li><a href="/feed">Flattr in feeds and HTML</a></li>
<li><a href="/partner">Partner site integration</a></li>
<li><a href="/tools">Tools</a></li>
<li><a href="/api/questions">Questions</a></li>
</ul>
<div class="page">
<div class="header">
<h2>Receive full resources instead of small</h2>
<div class="subtitle"></div>
</div>
<p>Now you can include a parameter called <code>full</code> in your request to certain resources
and all objects inside the resource will always return all information available.</p>
<p>Example fetching a thing</p>
<h5 >Request without <code>full</code> parameter</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2/things/450287
</code></pre><h6 >Response</h6>
<pre class="headers"><code>Status: 200 OK
Content-type: application/json;charset=utf-8
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999</code></pre>
<div class="highlight"><pre><span class="p">{</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">450287</span><span class="p">,</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"A ruby gem wrapping Flattrs API."</span><span class="p">,</span>
<span class="s2">"category"</span><span class="o">:</span> <span class="s2">"software"</span><span class="p">,</span>
<span class="s2">"resource"</span><span class="o">:</span> <span class="s2">"https://api.flattr.dev/rest/v2/things/450287"</span><span class="p">,</span>
<span class="s2">"flattrs"</span><span class="o">:</span> <span class="mi">9</span><span class="p">,</span>
<span class="s2">"flattrs_user_count"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span>
<span class="s2">"created_at"</span><span class="o">:</span> <span class="mi">1323614098</span><span class="p">,</span>
<span class="s2">"link"</span><span class="o">:</span> <span class="s2">"https://flattr.dev/thing/450287"</span><span class="p">,</span>
<span class="s2">"tags"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"gem"</span><span class="p">,</span>
<span class="s2">"ruby"</span><span class="p">,</span>
<span class="s2">"programming"</span><span class="p">,</span>
<span class="s2">"opensource"</span><span class="p">,</span>
<span class="s2">"flattr"</span><span class="p">,</span>
<span class="s2">"api"</span>
<span class="p">],</span>
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://github.com/simon/flattr"</span><span class="p">,</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"thing"</span><span class="p">,</span>
<span class="s2">"title"</span><span class="o">:</span> <span class="s2">"Ruby gem wrapping Flattrs API"</span><span class="p">,</span>
<span class="s2">"owner"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"resource"</span><span class="o">:</span> <span class="s2">"https://api.flattr.dev/rest/v2/users/smgt"</span><span class="p">,</span>
<span class="s2">"username"</span><span class="o">:</span> <span class="s2">"smgt"</span><span class="p">,</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"user"</span><span class="p">,</span>
<span class="s2">"link"</span><span class="o">:</span> <span class="s2">"https://flattr.dev/profile/smgt"</span>
<span class="p">},</span>
<span class="s2">"image"</span><span class="o">:</span> <span class="s2">"http://flattr.com/thing/image/4/5/0/2/8/7/medium.png"</span><span class="p">,</span>
<span class="s2">"language"</span><span class="o">:</span> <span class="s2">"en_GB"</span><span class="p">,</span>
<span class="s2">"hidden"</span><span class="o">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre>
</div>
<p>The <code>owner</code> is just represented with <code>resource</code>, <code>username</code>, <code>type</code>
and <code>link</code>.</p>
<h5 >Request with the <code>full</code> parameter</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2/things/450287?full
</code></pre><h5 >Response</h5><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">450287</span><span class="p">,</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"A ruby gem wrapping Flattrs API."</span><span class="p">,</span>
<span class="s2">"category"</span><span class="o">:</span> <span class="s2">"software"</span><span class="p">,</span>
<span class="s2">"resource"</span><span class="o">:</span> <span class="s2">"https://api.flattr.dev/rest/v2/things/450287"</span><span class="p">,</span>
<span class="s2">"flattrs"</span><span class="o">:</span> <span class="mi">9</span><span class="p">,</span>
<span class="s2">"flattrs_user_count"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span>
<span class="s2">"created_at"</span><span class="o">:</span> <span class="mi">1323614098</span><span class="p">,</span>
<span class="s2">"link"</span><span class="o">:</span> <span class="s2">"https://flattr.dev/thing/450287"</span><span class="p">,</span>
<span class="s2">"tags"</span><span class="o">:</span> <span class="p">[</span>
<span class="s2">"gem"</span><span class="p">,</span>
<span class="s2">"ruby"</span><span class="p">,</span>
<span class="s2">"programming"</span><span class="p">,</span>
<span class="s2">"opensource"</span><span class="p">,</span>
<span class="s2">"flattr"</span><span class="p">,</span>
<span class="s2">"api"</span>
<span class="p">],</span>
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://github.com/simon/flattr"</span><span class="p">,</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"thing"</span><span class="p">,</span>
<span class="s2">"title"</span><span class="o">:</span> <span class="s2">"Ruby gem wrapping Flattrs API"</span><span class="p">,</span>
<span class="s2">"owner"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"avatar"</span><span class="o">:</span> <span class="s2">"https://secure.gravatar.com/avatar/88bbe05fec72c1eba7c39d780c3bccae?s=48&r=pg"</span><span class="p">,</span>
<span class="s2">"city"</span><span class="o">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"country"</span><span class="o">:</span> <span class="s2">"Sweden"</span><span class="p">,</span>
<span class="s2">"resource"</span><span class="o">:</span> <span class="s2">"https://api.flattr.dev/rest/v2/users/smgt"</span><span class="p">,</span>
<span class="s2">"firstname"</span><span class="o">:</span> <span class="s2">"Simon"</span><span class="p">,</span>
<span class="s2">"lastname"</span><span class="o">:</span> <span class="s2">"Gate"</span><span class="p">,</span>
<span class="s2">"username"</span><span class="o">:</span> <span class="s2">"smgt"</span><span class="p">,</span>
<span class="s2">"link"</span><span class="o">:</span> <span class="s2">"https://flattr.dev/profile/smgt"</span><span class="p">,</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"user"</span><span class="p">,</span>
<span class="s2">"about"</span><span class="o">:</span> <span class="s2">"Human, programmer, climber, cyclist"</span><span class="p">,</span>
<span class="s2">"url"</span><span class="o">:</span> <span class="kc">null</span>
<span class="p">},</span>
<span class="s2">"image"</span><span class="o">:</span> <span class="s2">"http://flattr.com/thing/image/4/5/0/2/8/7/medium.png"</span><span class="p">,</span>
<span class="s2">"language"</span><span class="o">:</span> <span class="s2">"en_GB"</span><span class="p">,</span>
<span class="s2">"hidden"</span><span class="o">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre>
</div>
<p>As you can see the full <code>owner</code> object is included in the response.</p>
</div>
<address>Visit <a href="http://flattr.com/">Flattr.com</a> to learn more about Flattr.</address>
</div>
<script src="/js/ender.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-13236450-6']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>