基本的な使用方法
の基本的な使い方を説明しています。
API キーの発行
-
ユーザーポータル
にログインします。 「平和ネットAPIを使う」をクリックしてください。
備考
現在はGitHubのOAuth認証のみ利用可能です。
-
API Keysというページからキーを生成します。
キーの名前と有効期限を選択し、キーを生成しましょう! -
APIキーをコピーします
警告
紛失した場合は再度作成する必要があります。
APIにリクエストを送る
Linux / Mac
環境変数に
API_KEY
をセットします。
export API_KEY="YOUR_API_KEY"
簡単なリクエストを送ってみましょう!
curl -s -X POST \
--location 'https://api.pe-ace.net/v1/guardians/text' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $API_KEY" \
--data '{
"text": "最低な文章"
}'
Windows
環境変数に
API_KEY
をセットします。
$Env:API_KEY = "YOUR_API_KEY"
簡単なリクエストを送ってみましょう!
$headers = @{
"Content-Type" = "application/json"
"Authorization" = "Bearer $($Env:API_KEY)"
}
$body = @{
text = "最低な文章"
} | ConvertTo-Json
Invoke-RestMethod -Method Post -Uri "https://api.pe-ace.net/v1/guardians/text" -Headers $headers -Body $body
各言語での実装方法はコードリファレンスを参照してください。