API記事投稿

BOOKERS公式

2021/1/24 11:32

API記事投稿の簡易ドキュメント・チュートリアルです

投稿用API機能の解説です。順次更新いたします。

新機能 - 投稿用API

新機能追加（11/17）- 記事投稿API

bookers.tech

追加記事

API記事投稿2 - DLC追加

API記事投稿 DLC追加の簡易ドキュメントです

bookers.tech

API記事投稿5 - 下書き保存追加

API記事投稿下書き保存のエンドポイントです

bookers.tech

投稿用APIでできること

記事一覧取得[GET]、記事作成[POST]（/api/postcreate/)
記事詳細取得[GET]、記事更新[PATCH]（/api/postupdate/<記事uuid>）

APIキーの確認方法

アカウント設定下部より確認いただけます

設定可能項目

以下6項目を設定可能です。

項目名	型	説明
title	str(UTF8)<必須:255文字まで>	タイトル
category	int	カテゴリ（1:その他, 2:競馬, 3:競艇, 4:競輪, 5:テクノロジー, 6:ビジネス, 7:漫画, 8:創作, 9:音楽, 10:ライフスタイル, 11:コラム）
description	str(UTF8)	無料記事、有料記事無料部分。markdown記法対応
text	str(UTF8)	有料記事有料部分。markdown記法対応
price	int<0~50000>	価格
limited_number	int<1~>	有料販売記事数
is_disabled_copyguard	bool<Defalut:false>	コピーガード無効

1. 記事一覧取得[GET]、記事作成[POST]（/api/postcreate/)

記事一覧取得[GET]

サンプルコード

# curl
curl https://bookers.tech/api/postcreate/ 
　-X GET 
　-H 'Authorization: Token {{ token }}' 
# python 
import requests
headers = {
    'Authorization': 'Token {{token}}',
}
requests.get('https://bookers.tech/api/postcreate/', headers=headers)

成功：200

最新20件の記事詳細と次の20件取得用URLを返します

失敗：403

token情報がない場合認証エラーを返します

記事作成[POST]

サンプルコード

# curl
curl https://bookers.tech/api/postcreate/ 
　-X POST 
　-H 'Authorization: Token {{ token }}' 
　-H 'Content-Type: application/json' 
　-d '{"title":"タイトル","category":1,"description":"無料部分","text":"有料部分","image":image,"price":0}'
# python 
import requests
import json

headers = {
    'Authorization': 'Token {{token}}',
    'Content-Type': 'application/json',
}
data = {"title":"foo","category":1,"description":"foo","text":"foo","price":0,"limited_number":10}
requests.post('https://bookers.tech/api/postcreate/', headers=headers, data=json.dumps(data))
# メモ：文章中の改行は「\n」にて可能です。

サンプルレスポンス

成功：201

作成した記事詳細を返します。uuidは記事更新時に必要となります。

失敗：400

タイトルが未入力の場合、リクエストエラーを返します

2. 記事詳細取得[GET]、記事更新[PATCH]（/api/postupdate/<記事uuid>）

記事詳細取得[GET]

サンプルコード

# curl
curl https://bookers.tech/api/postupdate/{{uuid}}/ 
　-X GET 
　-H 'Authorization: Token {{ token }}' 
# python 
import requests
headers = {
    'Authorization': 'Token {{token}}',
}
requests.get('https://bookers.tech/api/postupdate/{{uuid}}/', headers=headers)

サンプルレスポンス

成功：200

指定されたuuidの記事詳細を返します

失敗：403

記事の作者以外詳細を確認できません

記事更新[PATCH]

サンプルコード

# curl
curl https://bookers.tech/api/postupdate/{{uuid}}/ 
　-X PATCH 
　-H 'Authorization: Token {{ token }}' 
　-H 'Content-Type: application/json' 
　-d '{"text":"有料部分"}'
# python 
import requests
headers = {
    'Authorization': 'Token {{token}}',
    'Content-Type': 'application/json',
}
data = '{"text":"有料部分"}'
requests.patch('https://bookers.tech/api/postupdate/{{uuid}}/', headers=headers, data=data)
# メモ：文章中の改行は「\\n」にて可能です。

サンプルレスポンス

成功：200