Her RaxBoard kurulumu Bearer kimlik doğrulamalı bir REST API ile gelir. Kapsamlı anahtarlar üretin; forumları, konuları, gönderileri, üyeleri, özel mesajları ve moderasyonu HTTP üzerinden okuyup yazın.
Makine-okunur bir OpenAPI 3.1 belgesi her ucu, kapsamı ve şemayı tanımlar. Swagger UI, Postman veya bir SDK üretecini forumunuzun spec’ine yönlendirin — ya da aşağıda interaktif inceleyin.
Anahtarınızı Authorization başlığında Bearer belirteci olarak gönderin. /api/v1 altındaki her uç bunu gerektirir; geçerli anahtarı olmayan istekler 401 döner.
Anahtarlar raxboard.com’da değil, forumunuzun içinde oluşturulur:
Her anahtar bir veya daha fazla kapsam taşır. Geniş kapsamlar (read, write, admin) alt kapsamları içerir; özel mesajlar ve yönetim işlemleri açık kapsam gerektirir.
| Kapsam | Ad | Açıklama |
|---|---|---|
| * | Tam erişim | Aşağıdaki her şey. Yalnızca tamamen güvenilen entegrasyonlara verin. |
| read | Okuma | Herkese açık forumları, konuları, gönderileri ve kullanıcıları okur. |
| write | Yazma | Yönetimsel olmayan tüm yazma işlemleri (gönderi, konu, tepki, düzenleme). |
| thread:write | Konu oluştur | Yeni konular açar. |
| post:write | Gönderi oluştur | Konulara yanıt verir. |
| post:manage | Gönderileri yönet | Gönderileri düzenler ve siler. |
| react:write | Tepki ver | Tepki ekler veya kaldırır. |
| conversation:read | Mesajları oku | Sahibin özel mesajlarını okur. |
| conversation:write | Mesaj gönder | Özel mesaj başlatır ve yanıtlar. |
| token | API anahtarlarını yönet | Kendi API anahtarlarınızı listeler ve iptal eder. |
| admin | Yönetim | Aşağıdaki tüm yönetimsel işlemler. |
| admin:users | Kullanıcıları yönet | Üye hesaplarını yasaklar, yasağı kaldırır ve yönetir. |
| admin:content | İçerik denetimi | Konuları ve gönderileri denetler. |
Her anahtarın dakikalık istek limiti vardır (varsayılan 60). Yanıtlar hız limiti başlıkları taşır; limit aşılırsa Retry-After ile HTTP 429 döner.
Başarılı yanıtlar { success: true, data: ... } biçiminde sarmalanır. Hatalar makine-okunur bir kod ve insan mesajıyla tutarlı bir zarf ve doğru HTTP durumu döner.
Liste uçları page ve per_page (en fazla 100) kabul eder. Yanıt bir pagination nesnesi ve first/prev/next/last bağlantılı RFC 5988 Link başlığı taşır.
/api/v1read/api/v1/authread/api/v1/forumsread/api/v1/forums/{id}read/api/v1/threadsread/api/v1/threadsthread:write/api/v1/threads/{id}read/api/v1/threads/{id}/postsread/api/v1/postsread/api/v1/postspost:write/api/v1/posts/{id}read/api/v1/posts/{id}post:manage/api/v1/posts/{id}post:manage/api/v1/posts/{id}/reactreact:write/api/v1/usersread/api/v1/users/meread/api/v1/users/{id}read/api/v1/notifications/alertsread/api/v1/searchread/api/v1/messagesconversation:read/api/v1/messagesconversation:write/api/v1/messages/{id}conversation:read/api/v1/messages/{id}/replyconversation:write/api/v1/admin/users/{id}/banadmin:users/api/v1/admin/users/{id}/unbanadmin:users/api/v1/admin/threads/{id}/deleteadmin:content/api/v1/admin/threads/{id}/restoreadmin:content/api/v1/admin/posts/{id}/deleteadmin:content/api/v1/admin/posts/{id}/approveadmin:content/api/v1/notifications/alerts/{id}/readwrite/api/v1/notifications/alerts/read-allwrite/api/v1/notifications/alerts/countread/api/v1/reactionsread/api/v1/posts/{id}/reactreact:write/api/v1/threads/{id}/bookmarkwrite/api/v1/posts/{id}/bookmarkwrite/api/v1/users/me/bookmarksread/api/v1/users/me/bookmarks/labelsread/api/v1/users/{id}/followwrite/api/v1/users/{id}/followwrite/api/v1/users/{id}/followersread/api/v1/users/{id}/followingread/api/v1/users/{id}/wallread/api/v1/users/{id}/wallwrite/api/v1/users/{id}/ignorewrite/api/v1/users/{id}/ignorewrite/api/v1/users/{id}/blockwrite/api/v1/users/{id}/blockwrite/api/v1/threads/{id}/watchwrite/api/v1/threads/{id}/watchwrite/api/v1/forums/{id}/readwrite/api/v1/forums/read-allwrite/api/v1/tagsread/api/v1/tags/{slug}/threadsread/api/v1/forums/{id}/prefixesread/api/v1/polls/{id}read/api/v1/polls/{id}/votewrite/api/v1/polls/{id}/votewrite/api/v1/threads/{id}/reportwrite/api/v1/posts/{id}/reportwrite/api/v1/admin/reportsadmin:content/api/v1/admin/reports/{id}/resolveadmin:content/api/v1/attachmentswrite/api/v1/attachments/{id}read/api/v1/users/mewrite/api/v1/users/me/preferencesread/api/v1/users/me/preferenceswrite/api/v1/users/me/custom-fields/{field_id}write/api/v1/users/me/ignoredread/api/v1/users/me/tokenstoken/api/v1/users/me/tokens/{id}token/api/v1/users/onlineread/api/v1/user-groupsread/api/v1/user-groups/{id}/membersread/api/v1/nodesread/api/v1/statsread/api/v1/eventsread/api/v1/events/{id}/rsvpwrite/api/v1/clubsread/api/v1/clubs/{id}/joinwrite/api/v1/users/me/drafts/{key}read/api/v1/users/me/drafts/{key}write/api/v1/broadcast/authread/api/v1/broadcast/pollread/api/v1/presence/thread/{thread_id}read/api/v1/presence/onlineread/api/v1/push/subscribereadyour-forum.com yerine kendi alan adınızı, YOUR_API_KEY yerine oluşturduğunuz bir anahtarı yazın.
REST API’nin yanında, forumunuz olaylar tetiklendiğinde dış servislere HMAC imzalı webhook gönderebilir — bunları Admin Paneli → Webhook’lar’dan ayarlayın.
Bu referans kendi RaxBoard kurulumunuzdaki API için geçerlidir. Dokümana dön →