Repository navigation
Expand file tree
/
Copy pathapi-docs.html
More file actions
427 lines (418 loc) · 19.7 KB
/
Copy pathapi-docs.html
File metadata and controls
427 lines (418 loc) · 19.7 KB
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
<!DOCTYPE html>
<html lang="fa">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>مستندات API عمومی | حق فراموش شدن</title>
<meta name="description" content="دریافت اطلاعات حذف حساب سرویسها از API عمومی حق فراموش شدن، همراه با فیلتر، صفحهبندی و نمونهٔ درخواست.">
<link rel="canonical" href="https://rtbf.ir/api-docs">
<meta property="og:title" content="مستندات API عمومی | حق فراموش شدن">
<meta property="og:description" content="دریافت اطلاعات حذف حساب سرویسها از API عمومی حق فراموش شدن، همراه با فیلتر، صفحهبندی و نمونهٔ درخواست.">
<meta property="og:url" content="https://rtbf.ir/api-docs">
<meta property="og:type" content="website">
<meta property="og:image" content="https://rtbf.ir/assets/img/og-image.png">
<link rel="icon" href="assets/img/favicon.png" sizes="32x32">
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.1/dist/css/bootstrap.min.css"
rel="stylesheet"
integrity="sha384-+0n0xVW2eSR5OomGNYDnhzAbDsOXxcvSN1TPprVMTNDbiYZCxYbOOl7+AMvyTG2x"
crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/all.min.css">
<link rel="stylesheet" href="assets/css/layout.css">
<link rel="stylesheet" href="assets/css/api-docs.css">
<script type="application/ld+json">{"@context": "https://schema.org", "@type": "TechArticle", "headline": "مستندات API عمومی | حق فراموش شدن", "description": "دریافت اطلاعات حذف حساب سرویسها از API عمومی حق فراموش شدن، همراه با فیلتر، صفحهبندی و نمونهٔ درخواست.", "url": "https://rtbf.ir/api-docs", "inLanguage": "fa"}</script>
</head>
<body dir="rtl">
<a class="skip-link" href="#main-content">رفتن به محتوای اصلی</a>
<header>
<div class="container menu">
<div class="row">
<div class="col-xl-12 col-lg-12 col-md-12 col-sm-12 col-12">
<nav
class="navbar navbar-expand-lg navbar-light bg-blur fixed-top main-menu"
aria-label="منوی اصلی"
>
<div class="container-fluid">
<button
class="navbar-toggler"
type="button"
data-bs-toggle="collapse"
data-bs-target="#navbarSupportedContent"
aria-controls="navbarSupportedContent"
aria-expanded="false"
aria-label="Toggle navigation"
>
<span class="navbar-toggler-icon"></span>
</button>
<div
class="collapse navbar-collapse"
id="navbarSupportedContent"
>
<ul class="navbar-nav m-auto text-center">
<li class="nav-item">
<a
href="index"
title="صفحهاصلی"
class="nav-link active text-dark"
><span class="fas fa-1x fa-home"></span> صفحهاصلی</a
>
</li>
<li class="nav-item">
<a
href="directory"
title="دایرکتوری سرویسها"
class="nav-link text-dark"
><span class="fas fa-1x fa-list"></span> دایرکتوری
سرویسها</a
>
</li>
<li class="nav-item">
<a
href="collabrator"
title="مشارکتکنندگان"
class="nav-link text-dark"
><span class="fas fa-1x fa-network-wired"></span>
مشارکتکنندگان</a
>
</li>
<li class="nav-item">
<a href="banners" title="بنرها" class="nav-link text-dark"
><span class="fas fa-1x fa-scroll"></span> بنرها</a
>
</li>
<li class="nav-item">
<a href="blog" title="وبلاگ" class="nav-link text-dark"
><span class="fas fa-1x fa-newspaper"></span> وبلاگ</a
>
</li>
<li class="nav-item">
<a
href="donate"
title="حمایت مالی"
class="nav-link text-dark"
><span class="fas fa-1x fa-donate"></span> حمایت مالی</a
>
</li>
<li class="nav-item">
<a
href="faq"
title="سوالات متداول"
class="nav-link text-dark"
><span class="fas fa-1x fa-question"></span> سوالات
متداول</a
>
</li>
<li class="nav-item">
<a href="api-docs" class="nav-link text-dark"><span class="fas fa-1x fa-book" aria-hidden="true"></span> مستندات API</a>
</li>
</ul>
</div>
</div>
</nav>
</div>
</div>
</div>
<div class="header-wall">
<div class="container heading">
<div class="row">
<div
class="col-xl-12 col-lg-12 col-md-12 col-sm-12 col-12 text-light"
dir="ltr"
>
<p class="links">
<a
target="_blank"
class="btn btn-info text-light share-twitter"
href="https://x.com/intent/tweet?text=اگر شما هم حذف حسابکاربری را دغدغهی خود میدانید از این سرویس استفاده کنید : rtbf.ir - @rtbf_ir"
rel="nofollow noreferrer noopener"
title="توییت کنید"
>توییت کنید <span class="fab fa-1x fa-x-twitter"></span>
</a>
<a
target="_blank"
class="btn btn-warning text-light contribute-github"
rel="nofollow noreferrer noopener"
href="https://github.com/rtbf-ir/rtbf.ir/issues/new/choose"
title="شما هم مشارکت کنید"
>شما هم مشارکت کنید <span class="fab fa-1x fa-github"></span>
</a>
</p>
</div>
</div>
</div>
</div>
<div class="breadcrumb">
<div class="container">
<div class="row">
<div class="col-xl-12 col-lg-12 col-md-12 col-sm-12 col-12">
<nav class="navbar" aria-label="مسیر صفحه">
<ul class="nav">
<li class="nav-item">
<a class="nav-link" href="index">حق فراموش شدن</a>
</li>
<li class="nav-item">
<a class="nav-link" href="api-docs" aria-current="page">مستندات API</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
</header>
<main id="main-content" tabindex="-1">
<div class="container api-docs my-5">
<h1>مستندات API حق فراموش شدن</h1>
<p>درخواستها <code>GET</code> هستند، کلید نمیخواهند و پاسخ JSON میدهند.</p>
<h2 id="api-start">مسیرها</h2>
<pre><code># بررسی سلامت
curl -fSsL 'https://rtbf.ir/api/v1/'
# همهٔ سرویسها
curl -fSsL 'https://rtbf.ir/api/v1/services/'
# یک سرویس با دامنهٔ ثبتشده
curl -fSsL 'https://rtbf.ir/api/v1/services/aparat.com'
# فیلتر
curl -fSsL 'https://rtbf.ir/api/v1/services/category=e-commerce&priority=2&status=medium-label&sort=oldest'</code></pre>
<h2 id="api-directory">فیلترها و صفحهبندی</h2>
<p>ترتیب فیلترها را مثل نمونه نگه دارید؛ <code>?</code> اضافه نکنید.
مقدار <code>all</code> محدودیت دستهبندی، اولویت یا وضعیت را برمیدارد.</p>
<table>
<caption>مقدارهای فیلترها</caption>
<thead><tr><th scope="col">فیلتر</th><th scope="col">مقدار</th></tr></thead>
<tbody>
<tr><th scope="row"><code>category</code></th><td><code>all</code> یا دستههای
<code>filters.category</code> در <a href="api/v1/">پاسخ سلامت</a></td></tr>
<tr><th scope="row"><code>priority</code></th><td><code>all</code>، <code>1</code>، <code>2</code> یا <code>3</code></td></tr>
<tr><th scope="row"><code>status</code></th><td><code>all</code>، <code>easy-label</code>،
<code>medium-label</code>، <code>hard-label</code> یا <code>impossible-label</code></td></tr>
<tr><th scope="row"><code>sort</code></th><td><code>newest</code> یا <code>oldest</code></td></tr>
</tbody>
</table>
<p>نتیجه در <code>data</code> و تعداد کل در <code>meta.total</code> است.
فهرست فیلترشده در صفحههای ۲۰تایی میآید؛ <code>links.next</code> و
<code>links.previous</code> مسیر صفحهٔ بعد و قبل هستند.</p>
<pre><code># صفحهٔ دوم
curl -fSsL 'https://rtbf.ir/api/v1/services/category=all&priority=all&status=all&sort=newest&page=2'</code></pre>
<p>نتیجهٔ خالی <code>data: []</code> میدهد؛ مسیر نامعتبر یا دامنهٔ ثبتنشده، خطای <code>404</code>.
برای هدر <code>application/json</code>، در دو مسیر اول <code>index.json</code>
و در مسیرهای دیگر <code>.json</code> اضافه کنید.</p>
</div>
</main>
<footer>
<div class="footer">
<div class="footer-sidebar">
<div class="container">
<div class="row">
<div
class="footer-sidebar-section service-detail col-xl-3 col-lg-3 col-md-12 col-sm-12 col-12 text-light text-center"
>
<a href="index" title="حق فراموش شدن"
><img
class="img-fluid"
src="assets/img/footer-logo.png"
title="حق فراموش شدن"
alt="حق فراموش شدن"
loading="lazy"
></a>
<nav class="navbar m-auto text-center">
<ul class="nav m-auto text-center">
<li class="nav-item">
<a
title="به کامیونیتی ما بپویندید"
href="https://t.me/+51BIjll9ZFFhY2Y8"
class="btn btn-light nav-link"
rel="nofollow noreferrer noopener"
target="_blank"
><span class="fas fa-1x fa-users"></span
></a>
</li>
<li class="nav-item">
<a
title="ما را در تلگرام دنبال کنید"
href="https://t.me/rtbf_ir"
class="btn btn-light nav-link"
rel="nofollow noreferrer noopener"
target="_blank"
><span class="fab fa-1x fa-telegram"></span
></a>
</li>
<li class="nav-item">
<a
title="ما را در توییتر دنبال کنید"
href="https://x.com/rtbf_ir"
class="btn btn-light nav-link"
rel="nofollow noreferrer noopener"
target="_blank"
><span class="fab fa-1x fa-x-twitter"></span
></a>
</li>
<li class="nav-item">
<a
title="ما را در اینستاگرام دنبال کنید"
href="https://www.instagram.com/rtbf_ir/"
class="btn btn-light nav-link"
rel="nofollow noreferrer noopener"
target="_blank"
><span class="fab fa-1x fa-instagram"></span
></a>
</li>
<li class="nav-item">
<a
title="صفحهی پروژه در گیت هاب را مشاهده کنید"
href="https://github.com/rtbf-ir/rtbf.ir"
class="btn btn-light nav-link"
rel="nofollow noreferrer noopener"
target="_blank"
>
<span class="fab fa-1x fa-github"></span>
</a>
</li>
</ul>
</nav>
</div>
<div
class="footer-sidebar-section col-xl-4 col-lg-4 col-md-12 col-sm-12 col-12 text-light"
>
<h4>این سرویس چگونه کار میکند؟</h4>
<p>
بسیاری از سرویسهای اینترنتی اینگونه عمل میکنند که امکان حذف
حسابکاربری را به شما نمیدهند و از نظر ما کاربران این موضوع
نقض حریم شخصی است. با توجه به حق فراموش شدن یا Right to be
forgotten این یک تضاد میباشد.
</p>
<p>
ایدهی اولیهی این سرویس از
<strong
><a
target="_blank"
href="https://backgroundchecks.org/justdeleteme/"
rel="nofollow noreferrer noopener"
title="justdeleteme"
>justdeleteme</a
></strong
>
گرفته شده است و بعد از
<strong
><a
target="_blank"
rel="nofollow noreferrer noopener"
href="https://x.com/nima/status/1398335801042386947"
>این توییت</a
></strong
>
تصمیم به راهاندازی آن گرفتم.
</p>
<p>
اگر قصد مشارکت دارید
<strong
><a
target="_blank"
href="https://github.com/rtbf-ir/rtbf.ir"
rel="nofollow noreferrer noopener"
title="rtbf.ir Source"
>از گیت هاب این کار را انجام دهید</a
></strong
>.
</p>
</div>
<div
class="footer-sidebar-section col-xl-5 col-lg-5 col-md-12 col-sm-12 col-12 text-light"
>
<h4>راهنمای استفاده</h4>
<p>
برچسبهای رنگی زیر مقدار سختی حذف حسابکاربری وبسایت/سرویس را
نمایش میدهد:
</p>
<p class="label-buttom">
<span class="btn easy-label text-white">ساده</span> - فرآیند
آسان
</p>
<p class="label-buttom">
<span class="btn medium-label text-white">متوسط</span> - به
صورت چندمرحلهای
</p>
<p class="label-buttom">
<span class="btn hard-label text-white">سخت</span> - نیاز به
ارسال پیام/تیکت به پشتیبانی
</p>
<p class="label-buttom">
<span class="btn impossible-label text-white">غیرممکن</span>
- غیرقابل حذف
</p>
<p>
برای افزودن سرویس جدید
<strong
><a
target="_blank"
href="https://rtbf.ir/issue"
title="rtbf.ir Issues"
>از اینجا</a
></strong
>
شروع کنید.
</p>
</div>
</div>
</div>
</div>
<div class="copyright">
<div class="container">
<div class="row">
<div class="col-xl-12 col-lg-12 col-md-12 col-sm-12 col-12">
<div class="float-right">
<p>
© <span id="copyrightyear"></span> | این سرویس به صورت
<strong
><a
class="text-dark"
target="_blank"
href="https://github.com/rtbf-ir/rtbf.ir"
rel="nofollow noreferrer noopener"
title="rtbf.ir Source"
>متن باز</a
></strong
>
و با لایسنس
<strong
><a
class="text-dark"
target="_blank"
href="https://www.apache.org/licenses/LICENSE-2.0"
rel="nofollow noreferrer noopener"
title="Apache-2.0 License"
>Apache-2.0 License</a
></strong
>
منتشر شده است. |
<strong
><small
><a
href="https://rtbf.ir/tos"
title="rtbf.ir Terms of service"
class="text-dark"
>قوانین سرویس</a
></small
></strong
>
</p>
</div>
<div class="float-left">
<p>
<span class="text-danger fas fa-1x fa-heart"></span>
<span class="text-brown fas fa-1x fa-coffee"></span>
</p>
</div>
<div class="clearfix"></div>
</div>
</div>
</div>
</div>
</div>
</footer>
<script
src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.1/dist/js/bootstrap.bundle.min.js"
integrity="sha384-gtEjrD/SeCtmISkJkNUaaKMoLD0//ElJ19smozuHV6z3Iehds+3Ulb9Bn9Plx0x4"
crossorigin="anonymous"
></script>
<script src="assets/js/copyright.js"></script>
</body>
</html>