Artikel Service
HomeArtikel Service
Api Reference
  • Artikel Controller
  • File Controller
  • Migration Controller
  • Milestone Controller
  • Q&A Controller
Changelog Release
HomeArtikel Service
Api Reference
  • Artikel Controller
  • File Controller
  • Migration Controller
  • Milestone Controller
  • Q&A Controller
Changelog Release
  1. Artikel Docs
  • Introduction
  • Changelog Release
  • Local Development
  • Artikel Docs
    • Artikel Controller Docs
    • File Controller Docs
  • article-controller
    • getArticleDiscovery
      GET
    • get user's list of viewed / liked articles
      GET
    • getTaxonomies
      GET
    • get list of featured articles by mode
      GET
    • getListSubCategory
      GET
    • get list of curated article by week
      GET
    • bulk index all published article to elastic search
      GET
    • delete all indexed article in elastic search
      DELETE
    • like / unlike an article
      POST
    • get article by slug and increase read counter
      GET
    • readDetailArticleV2
      GET
    • readDetailArticle
      GET
    • getWeeklyRecomendedArticle
      GET
    • get list of articles related to specific article by slug
      GET
    • get list of articles related to specific article by id
      GET
    • search (return list of articles related to) in all user's liked articles by term
      GET
    • search (return list of articles related to) in all articles by term
      GET
    • get url for sharing an article by id
      GET
    • get list of all article slug
      GET
    • getArticleOverviewSubCategory
      GET
    • getWeeklyTipsArticle
      GET
    • get list of user's activity (view, like, and share article)
      GET
    • getArticleByCategoryParent
      GET
    • getWeeklyRandomText
      GET
  • file-controller
    • streamPrivateData
  • migration-controller
    • testMigrateDev
  • milestone-controller
    • get list of baby milestones by month
    • get list of pregnancy milestones by week
  • question-and-ask-controller
    • get list of all specialists
    • create new user's question
    • update user's question
    • get list of all user's questions
    • get user's question detail by id
  1. Artikel Docs

Artikel Controller Docs

This service is used for .....

Get Article Discovery#

đź’ˇ
Rule :
The endpoint will be used to etrieving article recommendation data according to the mode baby or pregnancy
Endpoint Name : Get Article Discovery
Method : GET
URL :{base_url}/article/article-discovery
1. Requet Params
NoField NameData TypeField StatusDescription
1modeSTRINGMValue “baby” or “pregnancy”
Sample Request Params :
Mode = baby
2. Response Body

Get Article History#

đź’ˇ
Rule :
The endpoint will be used to get user list of viewed / liked articles
Endpoint Name : Get Article History
Method : GET
URL :{base_url}/article/article-history
1. Query Params
NoField NameData TypeField StatusDescription
1activitySTRINGMValue “view” or “like”
2pageNUMMThe page number which need to be displayed The page number which need to be displayed
Sample Query Params :
activity = view
page = 1
2. Response Body

Get Article Overview#

đź’ˇ
Rule :
The endpoint will be used to get taxonomies
Endpoint Name : Get Article Overview
Method : GET
URL :{base_url} /article/article-overview
1. Request Params
NoField NameData TypeField StatusDescription
1modeSTRINGMValue “baby” or “pregnancy”
2pageNUMMThe page number which need to be displayed The page number which need to be displayed
Sample Request Params :
mode = baby
page = 1
2. Response Body

Get Article Overview Feature#

đź’ˇ
Rule :
The endpoint will be used to get list of featured articles by mode
Endpoint Name : Get Article Overview Featured
Method : GET
URL :{base_url} /article/article-overview/featured
NoField NameData TypeField StatusDescription
1modeSTRINGMValue “baby” or “pregnancy”
2pageNUMMThe page number which need to be displayed The page number which need to be displayed
1. Request Params
Sample Request Params :
mode = baby
page = 1
2. Response Body

Get Category#

đź’ˇ
Rule :
The endpoint will be used to get list sub category
Endpoint Name : Get Category
Method : GET
URL :{base_url} /article/category/{categoryId}
1. Path
categoryId
sample path :
{base_url} /article/category/1
2. Query Params
NoField NameData TypeField StatusDescription
1pageNUMMThe page number which need to be displayed The page number which need to be displayed
Sample Request Params :
page = 1
3. Response Body

Get Curated article#

đź’ˇ
Rule :
The endpoint will be used to get list article of curated by week
Endpoint Name : Get Curated article
Method : GET
URL :{base_url} /article/curated-article
1. Query Params
NoField NameData TypeField StatusDescription
1weekNUMMpregnancy's age in week
Sample Request Params :
Week = 4
2. Response Body

Index#

đź’ˇ
Rule :
The endpoint will be used to bulk index all published article to elastic search
Endpoint Name : Index
Method : GET
URL :{base_url} /article/index
1. Response Body

Delete Index#

đź’ˇ
Rule :
The endpoint will be used to delete indexed article in elastic search
Endpoint Name : Delete Index
Method : DELETE
URL :{base_url} /article/index
1. Response Body

Like / Unlike Article#

đź’ˇ
Rule :
The endpoint will be used to like or unlike article
Endpoint Name : Like Article
Method : POST
URL :{base_url} /article/like
1. Request Body
NoField NameData TypeField StatusDescription
1likeBOOLEANMTrue if like or false if unlike
2postIdNUMMId of article
Example Request Body :
{
"like": true,
"postId": 4
}
2. Response Body

Read Article#

đź’ˇ
Rule :
The endpoint will be used to triger read article , to save counter read
Endpoint Name : Read Article
Method : GET
URL :{base_url} / article/read/{postId}
1. Path
NoField NameData TypeField StatusDescription
1postIdNUMMId of article
Example Path:
{base_url} / article/read/4
2. Response Body

Read by slug#

đź’ˇ
Rule :
The endpoint will be used to triger read article by slug , to save counter read
Endpoint Name : Read article by slug
Method : GET
URL :{base_url} /article/read/slug/{slug}
1. Path
NoField NameData TypeField StatusDescription
1slugSTRINGMslug of article
Example path :
{base_url} /article/read/slug/tips-untuk-ibu-di-minggu-ke-1
2. Response Body

Read Article v2#

đź’ˇ
Rule :
The endpoint will be used to triger read article , to save counter read (api version 2)
Endpoint Name : Read Article
Method : GET
URL :{base_url} / article/read/v2/{postId}
1. Path
NoField NameData TypeField StatusDescription
1postIdNUMMId of article
Example Path:
{base_url} / article/read/v2/4
2. Response Body

Get Recomended Article#

đź’ˇ
Rule :
The endpoint will be used to get recomended article by week and mode
Endpoint Name : Get Recomended article
Method : GET
URL :{base_url}/article/recomended-article
1. Query Params
NoField NameData TypeField StatusDescription
1weekNUMMpregnancy's age in week
2modeSTRINGMValue “baby” or “pregnancy”
Example Query Params :
{base_url}/article/recomended-article?week=1&mode=baby"
2. Response Body

Get Related Article#

đź’ˇ
Rule :
The endpoint will be used to get list of articles related to specific article by id
Endpoint Name : Get Related article
Method : GET
URL :{base_url}/article/related-article/{postId}
1. Path
NoField NameData TypeField StatusDescription
1postIdNUMMId of article
Example Path:
{base_url}/article/related-article/4
2. Response Body

Get Related Article By Slug#

đź’ˇ
Rule :
The endpoint will be used to get list of articles related to specific article by slug
Endpoint Name : Get Related article by slug
Method : GET
URL :{base_url}/article/related-article/slug/{slug}
1. Path
NoField NameData TypeField StatusDescription
1slugSTRINGMslug of article
Example path :
{base_url}/article/related-article/slug/tips-untuk-ibu-di-minggu-ke-1
2. Response Body

Search By Term#

đź’ˇ
Rule :
The endpoint will be used to search (return list of articles related to) in all articles by term
Endpoint Name : Search by Term
Method : GET
URL :/article/search/{term}
1. Path
NoField NameData TypeField StatusDescription
1termSTRINGMterm for searching purpose
Example Path :
/article/search/hamil
2. Query Params
NoField NameData TypeField StatusDescription
1pageNUMMThe page number which need to be displayed The page number which need to be displayed
Sample Request Params :
page = 1
2. Response Body
Modified at 2023-02-01 03:28:12
Previous
Local Development
Next
File Controller Docs
Built with