Docs

  • WSOFT Docs
  • あみうは
    • あみうは
    • 新学期が始まりました!
    • 恋の相談
    • プチコン3号で作ったのは?
    • オススメの文庫
    • マクドナルド最高!
    • ios11β レビュー
    • あみうはの歌について
    • ついに自分のソフトウェアのホームページができました。
    • Windowsタブレットをリセットして起動しなくなった人のために
    • PCレスで YouTubeの曲を携帯mp3プレイヤーで聴く(iPhone)
    • 食べられないラズベリーパイを買いました。(1)
    • ラズベリーパイの下ごしらえ(2)
    • 小説始めます~
    • 女子がキュンとくる行動ベスト3!!
    • MacとWindowsについてあまり知られていない事
    • macでできる裏技
    • ドコモの格安スマホ「MONO」買っちゃいました☆いい所をいくつか
    • 『レビュー』iPhone6sを1年間使い続けて思ったこと
    • iPhoneの拡大鏡に関するバクを発見しました。
    • iPhoneで圧縮ファイルを作成したり解凍する方法
    • Obscura2が今だけ無料!使い方まとめ
    • Windowsタブレットがブルースクリーンになった時のメモ
    • お知らせ
      • あみうはからのお知らせ
      • あみうは ブログ始めました。
      • 予告 web ページの更新について 🇯🇵ver 2.0.0.jp Deep Space 🇺🇸ver 2.0.0 Deep Space
      • あみうはショップから大切なお知らせ
      • みんなの投稿サービス終了のお知らせ
      • あけましておめでとうございます
      • あみうはホームページをアップデートしました。
      • あみうは はついに1周年を迎えました!!1年間を振り返ります!
      • あみうはダウンロードの閉鎖について
      • 特定商取引法に基づく表記
      • あみうは系サイトの閉鎖について
  • ブログ
    • ブログ
    • WSOFT AdventWeek 2022のお知らせ
    • DiscordのBotは多重人格の夢を見るか?
    • WSOFTのアイコンを入手する
    • WSOFTDocs へようこそ
    • WSOFTの製品の一覧
    • wsoft.wsへのドメイン移行に関する情報
    • WSOFTのロゴ変更に関する情報
    • WSOFTのドキュメントの WSOFT Docs への移行に関する情報
    • Raspberry Pi初代やZeroでAliceScriptを実行する
    • Losetta0.9.16に更新した後のエラーを直す
    • WSOFT AdventWeekへようこそ
  • 共同作成ガイド
    • 概要
    • コントリビュータ行動規範
    • リンクの使い方
    • Markdownリファレンス
    • メタデータ
    • テキストの書式設定に関する指針
  • 法的資料
    • 法的資料
    • Alice-EULA-R
    • WSOFT-EULA
    • WSTube エンドユーザー利用規約
    • あみうは利用規約
    • WSOFTダウンロードセンター利用規約
    • 使用条件
  • 製品
    • 製品
    • PCMX
      • ブートローダーメニューの使い方
    • WSOFTアカウント
      • WSOFTアカウントの概要
      • WebからWSOFTアカウントにログインする
      • WindowsアプリからWSOFTアカウントにログインする
      • WSOFTオンライン手続きの概要
    • AliceScript
      • AliceScript
      • 謝辞
      • ダウンロード
      • Alice(キャラクター)
      • AliceScriptのツアー
      • Wikiの概要
      • APIブラウザー
        • APIブラウザー
        • Alice
          • delay
          • exit
          • function
          • import
          • include
          • lock
          • print
          • string_format
          • using
          • write
          • Environment
            • env_commandLine
            • env_commandLineArgs
            • env_set_exitCode
            • env_hasshutdownstarted
            • env_Is64BitOperatingSystem
            • env_Is64BitProcess
            • env_MachineName
            • env_NewLine
            • env_os_platform
            • env_os_version
          • Exception
            • Exception
            • ErrorCode
            • Message
            • ToString
          • Interpreter
            • Type
              • Type
              • Activate
              • Base
              • IsObject
              • Namespace
              • ToNativeProperty
              • ToString
          • Math
            • math_abs
            • math_acos
            • math_acosh
            • math_atan
            • math_atan2
            • math_atanh
            • math_bitdecrement
            • math_bitincrement
            • math_cbrt
            • math_celling
            • math_clamp
            • math_copysign
            • math_cos
            • math_cosh
            • math_e
            • math_exp
            • math_floor
            • math_fusedmultiplyadd
            • math_isprime
            • math_max
            • math_min
            • math_pi
            • math_pow
            • math_round
            • math_sin
            • math_sinh
            • math_sqrt
            • math_tan
            • math_tanh
            • math_tau
            • math_truncate
          • Net
            • web_download_file
            • web_download_file
            • web_download_text
            • web_htmldecode
            • web_htmlencode
            • web_send_ping
            • web_upload_data
            • web_upload_file
            • web_upload_text
            • web_urldecode
            • web_urlencode
          • Security
            • password_hash
            • password_hash_data
            • password_salt
            • password_verify
            • password_verify_data
          • Threading
            • signal
            • signal_wait
            • task_run
            • thread_id
            • thread_queue
        • Array
          • array
          • Add
          • AddRange
          • All
          • Any
          • Contains
          • Distinct
          • Except
          • First
          • Flatten
          • Foreach
          • IndexOf
          • Insert
          • InsertRange
          • Intersect
          • Last
          • Length
          • Merge
          • OfType
          • OrderBy
          • OrderByDescending
          • Remove
          • RemoveAt
          • RemoveRange
          • Reverse
          • Select
          • SequenceEqual
          • Size
          • Skip
          • SkipWhile
          • Sort
          • Take
          • TakeWhile
          • Union
          • Where
        • Bool
          • bool
        • Bytes
          • bytes
        • Delegate
          • delegate
          • BeginInvoke
          • Invoke
        • None
          • none
        • Number
          • number
        • String
          • string
          • CompareTo
          • Contains
          • EndsWith
          • Format
          • IndexOf
          • Insert
          • IsEmptyOrNull
          • IsEmptyOrWhite
          • IsNormalized
          • Join
          • LastIndexOf
          • Normalize
          • PadLeft
          • PadRight
          • Remove
          • RemoveAt
          • Replace
          • Split
          • StartsWith
          • SubString
          • ToLower
          • ToLowerInvariant
          • ToUpper
          • ToUpperInvariant
          • Trim
          • Trim
          • TrimStart
        • Variable
          • variable
          • Clone
          • Convert
          • DeepClone
          • Dispose
          • Equals
          • Properties
          • ToString
          • Type
      • 変更履歴
        • 新機能の一覧
        • AliceScript GoldenMasterの新機能
        • AliceScript 2.1の新機能
        • AliceScript 2.2の新機能
        • AliceScript 2.3の新機能
        • 互換性に影響を与える変更点
        • Nightyビルドの変更履歴
        • AliceScript RC2の新機能
        • Losetta
          • Losettaの更新履歴
          • Losetta 0.9.15
          • Losetta 0.9.16
          • Losetta 0.9.17
          • Losetta 0.9.18
          • Losetta 0.9.19
          • Losetta 0.9.20
      • 基本
        • 基本
        • AliceScript ADK
        • AlicePackage
        • AliceSister
        • AliceSister
        • AliceScriptのコーディング規約
        • イベント
        • 例外
        • 式
        • 前処理指令
        • AliceModel
        • 変数
      • Alice in Discord
        • Alice in Discordの紹介
        • Alice in Discordの基礎
        • Alice in Discord コミュニティガイドライン
        • Alice in Discordに関連するプロジェクトの一覧
      • 相互運用
        • 基本的なAliceScriptライブラリの開発
      • チュートリアル
        • チュートリアル
        • 初めてのAliceScript
        • パッケージのビルド
        • 数値型の計算誤差
        • 自分自身の関数を取得する
        • AlicePackageの関連付け
        • WSOFTScriptからの移行
        • AliceScriptで安全にパスワードを保存する
        • Losettaを更新する
    • ダウンロードセンター
      • WSOFTダウンロードセンターの概要
      • API
      • 検索
      • マネージャー
        • WSOFTダウンロードセンターマネージャーの概要
        • 更新履歴
          • WSOFTダウンロードセンター管理端末の更新情報
          • バージョン50
          • バージョン53
    • ほめて.ws
      • ほめて.wsの概要
    • アイコンメーカー
      • アイコンメーカーの概要
    • WSOFTScript
      • WSOFTScript
      • WSOFTScript 0.07 R3
      • WSOFTScript 0.07 R4
      • WSOFTScript 2020 LTSの情報
      • WSOFTScriptのライフサイクル
      • 使用されているLosettaのバージョンを確認する
      • WSOFTScript Pocket 2020 Beta
      • Shangri-la 0.07 R4
      • Shangri-la 2020 LTS
    • Unidet
      • Unidetへようこそ
    • WebSailing
      • WebSailing
      • 謝辞
      • APIブラウザー
      • 更新履歴
        • WebSailingNXの更新情報
        • NX 83
        • NX 104.1
        • NX 105
        • NX 105.1
        • NX 106
        • NX 106.1
        • NX 106.2
        • NX 107
        • NX 107.1
        • NX 107.2
        • NX 108
        • NX 109
        • NX 110
        • NX 110.1
        • NX 110.2
        • NX 110.3
        • NX 111
      • GL
        • WebSailingの仕様について(GL系のみ)
        • 更新履歴
          • WebSailingGLの更新情報
          • 1.5.01
          • 1.5.02
          • 1.5.03
          • 1.5.04
          • 1.5.05
          • 1.5.06
          • 2.0
          • 2.1
          • 3.0
          • 20Edition
        • ガイド
          • WebSailingGLプロンプトリファレンス
          • エラーコードE001
          • エラーコードE002
          • エラーコードE003
          • エラーコードU001
          • エラーコードU002
          • WebSailingGLで特定のUrlをブロックする方法
          • WebSailingを更新する方法
          • WebSailingヘルプ
          • WebSailingのコンポーネント変更についてのお知らせ
          • WebSailingプロンプトを極める!その1 API を極める
      • NX(レガシー)
        • WebSailingNX(レガシー)
        • 更新履歴
        • 開発者向け
          • サービス終了後も拡張機能を実行する方法
          • プラグインからSafeBrowsingAPIを呼び出す
          • プラグインガードの概要
        • ガイド
          • WebSailingNXターミナルリファレンス
          • PlusLibraryでライブラリエラー500が発生する場合
          • 認識エラーM300が発生する場合
          • WebSailingのキャッシュを削除する
          • 全画面表示を使う方法
          • WebSailingヘルプ
          • WIWで、NXツールを使う
          • おまけ
          • 捕捉されなかった例外が発生しましたと表示される場合
        • PlusLibrary
          • WSTubeMOD
          • 携帯電話モード
          • 郵便番号検索
      • チュートリアル
        • チュートリアル
        • 起動時に使用される設定を構成する
        • 設定が原因で起動できないと考えられる場合の対処方法
        • WebSailingのWindows7/8.1 Server2012/R2のサポート終了に関するお知らせ
        • AliceScriptを使ってWebSailingを制御する
    • WSNET
      • WSNET
      • WSNETの概要
      • ニュース
        • ニュース
        • WSNET/WAN DHCP機能提供開始
        • WSOFTダウンロードセンターマネージャー v42リリース
        • WSNETDocs提供開始
        • WSOFTダウンロードセンターマネージャーのWSOFTダウンロードセンターマネージャーDocsへの移行に関するお知らせ
      • チュートリアル
        • チュートリアル
        • SoftEtherを使用してWSWANに接続する
        • OpenVPNを使用してWSWANに接続する
        • 証明書のインストール
    • WSTodon
      • WSTodonの概要
      • よくある質問と回答
    • WSTube
      • WSTubeの紹介
      • クレジット
      • WSTube ユーザーガイド
      • お知らせ
        • WSTube NEXTの紹介
        • WSTube NEXT Procyonの紹介
        • WSTube NEXT October’2019の紹介
    • Lantana
  • 生存報告
    • 生存報告
    • 22年度1学期
      • 生存報告
      • イントロダクション
      • おやすみ。
      • 生存報告
      • つながり
      • 生存報告論
      • その一言で、
      • 信じるということ
      • またね。
    • 22年度2学期
      • やさしさ
      • 心の城
      • 勤労感謝の日
      • 自分のことを助けられるのは自分しかいない
      • 大丈夫は大丈夫じゃない
      • おしごと
      • 大きなものは無視できない
      • 石ころの唄
      • 表裏一体
目次
  • はじめに
  • 主なユースケース
  • 使用方法
  • バージョンの取得
    • 戻り値
    • 使用例
  • コンテンツの取得
    • 戻り値
    • 使用例
  • コンテンツの情報の取得
    • 戻り値
    • 使用例
  • コンテンツの検索
    • 戻り値
    • 使用例
  • エラー

API

  1. WSOFTDocs
  2. 製品
  3. ダウンロードセンター
  4. API

WSOFTダウンロードセンターAPIは、WSOFTダウンロードセンターから提供されるリソースを他のプログラム等から呼び出し、ダウンロードや情報の取得をするためのAPIを提供します。 この記事は、WSOFTダウンロードセンターAPIを使用しようとしている技術者やソフトウェア開発者をターゲットにしています。


たい | 2022-7-6

はじめに

WSOFTダウンロードセンターAPIは、WSOFTダウンロードセンター内のコンテンツやその情報を取得、検索する機能を提供するWebサービスです。APIの使用には、利用規約への同意が必要です。

主なユースケース

  • ハッシュを使用したダウンロードの正当性の検証
  • WSOFTダウンロードセンターからファイルを取得するアプリケーションの開発
  • 自分のコンテンツ内へのWSOFTダウンロードセンターから提供されるコンテンツの埋め込み

Warning

WSOFTダウンロードセンターAPIによってコンテンツの埋め込みが可能であったとしても、コンテンツの権利者があなたのコンテンツへの埋め込みを許可するとは限りません。詳しくは、各コンテンツのページを参照するか、そのコンテンツの権利者にお問い合わせください。

使用方法

WSOFTダウンロードセンターAPIは、以下のサーバーで運用されています。

Url
https://api.wsoft.ws/download

バージョンの取得

次のリソースを開くと、WSOFTダウンロードセンターのバージョンまたはそのAPIのバージョンが取得できます。このメソッドにパラメータはありません。

Url
https://api.wsoft.ws/download/version.json
Url
https://download.wsoft.ws/version.json

戻り値

バージョン情報がJSON形式で次のように返却されます。

version.json
{
  "Product" : "{PRODUCT_NAME}",
  "CodeName" : "{CODE_NAME}",
  "Version" : "{VERSION}",
  "FullName" : "{FULL_NAME}"
}
パラメータ 説明
Product プロダクト名。WSOFTダウンロードセンターの場合はWSOFTDownloadCenterが、WSOFTダウンロードセンターAPIの場合はWSOFTDownloadCenter.APIが返却されます。
CodeName コード名。現在、WSOFTダウンロードセンターの場合はchihayaが、WSOFTダウンロードセンターAPIの場合はchihayaⅡが返却されます。
Version バージョン番号
FullName 製品の完全な名前。これは、「{Product} v{Version}({CodeName})」の形式で返却されます。

使用例

実際のWSOFTダウンロードセンターでのバージョンはversion.jsonから、WSOFTダウンロードセンターAPIでのバージョンはversion.jsonから取得できます。

コンテンツの取得

GETまたはPOSTメソッドを使用して、WSOFTダウンロードセンター内にあるコンテンツを直接取得します。

Url
https://api.wsoft.ws/download/resource
パラメータ 説明
id 取得したいコンテンツのダウンロードID
key 取得したいコンテンツのダウンロードキー。この値は省略できます。

戻り値

取得したコンテンツのバイナリがそのまま返却されます。

使用例

次の例では、ダウンロードIDがWS0000のコンテンツを取得します。

Url
https://api.wsoft.ws/download/resource?id=0

WSOFTダウンロードセンターへのリンクとの違い

WSOFTダウンロードセンターでは、コンテンツの取り扱いを指定するヘッダーである、Content-Dispositionが、ダウンロードさせることを要求するattachmentに設定されています。しかし、WSOFTダウンロードセンターAPI空の呼び出しでは、Webページのコンテンツとして扱うinlineに設定されます。他にも、ファイル名が提供されなかったり、直接ダウンロードキーを指定してダウンロードできるなどの相違点があります。

コンテンツの情報の取得

GETまたはPOSTメソッドを使用して、WSOFTダウンロードセンター内にあるコンテンツの情報を取得します。

Url
https://api.wsoft.ws/download/detail
パラメータ 説明
id 取得したいコンテンツのダウンロードID
key 取得したいコンテンツのダウンロードキー。この値は省略できます。
feature 取得したいコンテンツのパラメータ。この値は省略できます。

戻り値

取得したコンテンツの情報がJSON形式で次のように返却されます。

https://api.wsoft.ws/download/detail
{
  "Status" : "{STATUS}",
  "Request_ID" : "{ID}",
  "Now" : "{ACCEPTED_DATETIME}",
  "Copyright" : "{CONTENT_COPYRIGHT_INFO}"
  "Release_Date" : "{CONTENT_RELEASED_DATE}",
  "Description" : "{CONTENT_DESCRIPTION}",
  "FileName" : "{CONTENT_FILENAME}",
  "Hash" : "{CONTENT_SHA512_HASH}"
  "Licence" : "{CONTENT_LICENCE_INFO}",
  "Licence_Url" : "{CONTENT_LICENCE_INFO_URL}",
  "MIME" : "{CONTENT_MIME_TYPE}",
  "FileSize" : "{CONTENT_FILE_SIZE}"
  "Tags" : "{CONTENT_TAGS_TEXT}",
  "Title" : "{CONTENT_TITLE}",
  "Version" : "{CONTENT_VERSION}",
  "Support_Seartch" : "{IS_VISIBLE_IN_SEARTCHES}"
  "Support_Preview" : "{IS_SUPPORT_PREVIEW}"
}
パラメータ 説明
Status 取得に成功すればFoundが、ダウンロードIDが見つからない場合はNotFoundが、ダウンロードキーが異なる場合はWrong_DownloadKeyが、その他の例外が発生した場合はService_Unavailableが返却されます。
Request_ID 要求したダウンロードID
Now 要求を受理あるいは棄却した日付と時刻
Copyright 要求したコンテンツの著作権情報
Release_Date 要求したコンテンツの公開日。yyyy-MM-ddの形式で返却されます。
Description 要求したコンテンツの説明
FileName 要求したコンテンツのファイル名
Hash 要求したコンテンツのSHA512チェックサム
License 要求したコンテンツのライセンス情報
License_Url 要求したコンテンツの提供者が指定したライセンスの詳細情報へのUrl
MIME 要求したコンテンツのMIME
FileSize 要求したコンテンツのファイルサイズを表す文字列
Tags 要求したコンテンツに関連付けられたタグ。タグは#{TAG_TEXT}:{COLOR_CODE}の形式で返却されます。
Title 要求したコンテンツのタイトル
Version 要求したコンテンツのバージョン
Support_Seartch 要求したコンテンツが一覧や検索に表示されるか否かを表す値。表示される場合はtrue、それ以外の場合はfalse。
Support_Preview 要求したコンテンツがファイルのプレビューをサポートするか否かを表す値。サポートする場合はtrue、それ以外の場合はfalse。

使用例

次の例では、ダウンロードIDがWS0123のコンテンツの情報を取得します。

Url
https://api.wsoft.ws/download/detail?id=123

次の例では、ダウンロードIDがWS0123のコンテンツのタイトルを取得します。

Url
https://api.wsoft.ws/download/detail?id=123&feature=title

コンテンツの検索

GETまたはPOSTメソッドを使用して、WSOFTダウンロードセンター内にあるコンテンツの情報を取得します。

Url
https://api.wsoft.ws/download/seartch
パラメータ 説明
query 検索するクエリ

戻り値

取得したコンテンツの情報がJSON形式で次のように返却されます。

https://api.wsoft.ws/download/seartch
{
  "Status" : "{STATUS}",
  "Request_Query" : "{SEARTCH_QUERY}",
  "Now" : "{ACCEPTED_DATETIME}",
  "ID" : "{FOUND_CONTENT_ID}"
}
パラメータ 説明
Status クエリに適合するコンテンツが見つかった場合はFoundが、見つからない場合はNotFoundが、ダウンロードキーが異なる場合はWrong_DownloadKeyが、その他の例外が発生した場合はService_Unavailableが返却されます。
Request_Query 要求したクエリ
Now 要求を受理あるいは棄却した日付と時刻
ID 要求したクエリに適合するコンテンツのID。この項目は適合するコンテンツが見つかる限りいくつでも繰り返されます。

使用例

次の例では、クエリ*を実行し、WSOFTダウンロードセンター内で公開されているすべての検索可能なコンテンツを取得します。

Url
https://api.wsoft.ws/download/seartch?query=*

エラー

エラーはJSON形式で次のように返却されます。

エラー
{
  "Status" : "{STATUS}",
  "Request_ID" : "{ID}",
  "Now" : "{REJECTED_DATETIME}"
}

Note

NotFoundエラーが発生した場合はHTTPステータスコード404が、それ以外の場合は200が返却されます。

パラメータ 説明
Status エラーの内容。ダウンロードIDが見つからない場合はNotFoundが、ダウンロードキーが異なる場合はWrong_DownloadKeyが、その他の例外が発生した場合はService_Unavailableが返却されます。
Request_ID 要求したダウンロードID
Now 要求を棄却あるいは失敗した日付と時刻
検索
No results found