...
| Code Block |
|---|
let localEnvVariables = {
NODEBB_SERVICE_URL: env.nodebb_service_url || 'http://localhost:4567',
Authorization: env.authorization_token || 'd8402b15-1d5f-4d84-9fae-595ef805f287', // Your local nodebb Master token
nodebb_api_slug: env.nodebb_api_slug || '/api'
} |
| Info |
|---|
Note: If your testing the DF-lib using demo application. You have to use user token instead of master token. Once we implemented DF-middleware cache then onwards no need to change the token. we can use master token itself. |
Step:4
Run the discussion middleware using the command npm run start. Discussion-middleware will run on port 3002.
...
| Info |
|---|
Note: Demo application will run on port 4200. |
Nodebb api documentation
We can see all discussion forum api here : Discussion forum apis.
Discussion forum integration with any application
Discussion forum is library and can be attached to any application. Before integrating we have to verify following things
Application should maintain cache.
Discussion forum uid have to be stored in cache.
Uid need to attach for all discussion forum apis as a query param link
?_uid=${discussionForum_uid}.
Add discussion for a context
We can attach discussion forum for any context like Groups/Courses/Batchs/Textbooks…etc.
Before attaching discussion forum we have to create one parent category and for context have one parent category. So that we can have all group context under one parent similarly for course, textbook.
You can see below image. Discussion forum for Groups is a parent category and all group related discussion forums are under that category.
...
Schema
SbType | SbIdentifier | cid | Data |
|---|---|---|---|
course | do_11317805943810457614592 | 5 | {JSON} |
batch | 01316730820300800028 | 6 | {JSON} |
group | 123475d2-c299-45f6-992e-a22d081431bd | 7 | {JSON} |
For example, We are adding discussion forum for group, For that we have to use below api.
Request
URL: https://staging.sunbirded.org/discussion/forum/v3/create
Payload:
| Code Block |
|---|
{
"category": {
"name": "General Discussion", // Name of the category
"pid": "30", // parent category id, under this category we are creating new categories
"description": "", // category description: Optional
"context": [
{
"type": "group", // type as a group
"identifier": "bc190919-f9a4-4e8a-a48b-2bba9c0b827f" // group Id
}
]
}
} |
| Code Block |
|---|
curl 'https://staging.sunbirded.org/discussion/forum/v3/create' \
-H 'Connection: keep-alive' \
-H 'sec-ch-ua: " Not;A Brand";v="99", "Google Chrome";v="97", "Chromium";v="97"' \
-H 'X-App-Id: staging.sunbird.portal' \
-H 'sec-ch-ua-mobile: ?0' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.71 Safari/537.36' \
-H 'Content-Type: application/json' \
-H 'Access-Control-Allow-Origin: *' \
-H 'Accept: application/json' \
-H 'X-Device-Id: 23b82f7e68c9974eb17af148415a6067' \
-H 'X-Channel-Id: 0126796199493140480' \
-H 'sec-ch-ua-platform: "macOS"' \
-H 'Origin: https://staging.sunbirded.org' \
-H 'Sec-Fetch-Site: same-origin' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Sec-Fetch-Dest: empty' \
-H 'Referer: https://staging.sunbirded.org/my-groups/group-details/bc190919-f9a4-4e8a-a48b-2bba9c0b827f' \
-H 'Accept-Language: en-GB,en;q=0.9' \
-H 'Cookie: connect.sid=s%3AS3j18UnlsjcbY4_kbWjfCdO7iBvR0h_G.1dWXH%2Ba%2BUZ3zyFN4JnK2ucdU9mFqkRfmiPJrTgxulPU' \
--data-raw '{"category":{"name":"General Discussion","pid":"30","uid":"4","description":"","context":[{"type":"group","identifier":"bc190919-f9a4-4e8a-a48b-2bba9c0b827f"}]}}' \
--compressed |
Response
| Code Block |
|---|
{
"id": ".discussions.api.forum.v3.create",
"ver": "1.0",
"ets": 1642673148032,
"params": {
"resmsgid": "16ea8c5b-682c-4ac2-889e-d5896fc057fd",
"msgid": "",
"status": "Success"
},
"responseCode": "OK",
"result": {
"forums": [
{
"sbType": "group",
"sbIdentifier": "bc190919-f9a4-4e8a-a48b-2bba9c0b827f",
"newCid": 801, // New category created for group context
"cids": [801]
}
]
}
} |
In the above response we have newCid that is the category id which is created for the group context that we pass in the request. So whet ever the discussions happened in the group are present in the discussion forum category.
...