API (ステータス & 課金情報)

本文書に含まれるAPI Endpointは実験目的で開発・運営中です。

APIの基本的な使い方は API（抽出データ）でご確認ください。

API（抽出作業ステータス、決済情報）の種類

• 決済情報（Billing）：購読中の商品に関する決済情報を表示します。

• シングル抽出ステータス（SingleTask Status）：抽出作業のステータス（wait、doing、success、fail）を表示します。

• グループ抽出ステータス（GroupTask Status）：抽出作業のステータス（wait、doing、success、fail）を表示します。

API Endpoint & Response

Billing（決済情報）API

種類	URI	リクエスト方式
Billing	https://listly.io/api/billing	GET
	次の情報を返します。 plan：購読中のプラン reset：次月の購読更新日 expire：（年間購読の場合）購読満了日 usage：使用可能なURL数 proxy：自動決済で追加購入するプロキシサーバー url：自動決済で追加購入するURL autopay：次月の自動決済の有無

レスポンス例

{
    "plan": "business",
    "reset": "2023-04-17T19:00:00+09:00",
    "expire": "2023-09-05T13:48:39.443+09:00",
    "usage": {
        "available": 8738,
        "total": 9000
    },
    "addon": {
        "proxy": {
            "currency": "KRW",
            "price": 0
        },
        "url": {
            "currency": "KRW",
            "price": 0
        }
    },
    "autopay": false
}

SingleTask（シングル抽出ステータス）API

種類	URI	リクエスト方式
SingleTask Status	https://listly.io/api/single/status?key=<singlekey>	GET
	次の情報を返します。 key：シングル抽出のtaskkey type：wholeまたはpart（全体または部分抽出） status：抽出ステータス（wait、doing、success、fail） updated：抽出作業の最終変更日 created：抽出作業の最初の作成日

レスポンス例

{
    "key": "SGzSoRqJ",
    "type": "part",
    "status": "success",
    "updated": "2023-04-11T08:45:01.109+09:00",
    "created": "2022-12-02T17:23:46.108+09:00"
}

GroupTask（グループ抽出ステータス）API

種類	URI	リクエスト方式
Group info. & GroupTask Status	https://listly.io/api/group/status?key=<groupkey>	GET
	次の情報を返します。 key：グループ抽出のtaskkey type：wholeまたはpart（全体または部分抽出） name：グループ名 status：抽出ステータス（wait、doing、success、fail） updated：抽出作業の最終変更日 created：抽出作業の最初の作成日 tasks：登録されたグループ抽出作業の情報および抽出ステータス

レスポンス例

{
    "key": "vk9q2sJQ",
    "type": "part",
    "name": "www.youtube.com",
    "status": {
        "success": 246,
        "total": 246
    },
    "updated": "2022-09-29T00:19:33.794+09:00",
    "created": "2022-09-28T23:47:16.708+09:00",
    "tasks": [
        {
            "url": "https://www.youtube.com/watch?v=0KnUyy6pH-U",
            "status": "success",
            "updated": "2022-09-29T00:08:13.905059+09:00",
            "created": "2022-09-28T23:47:17.102288+09:00"
        },
        {
            "url": "https://www.youtube.com/watch?v=bGpzWPUbP3s",
            "status": "success",
            "updated": "2022-09-28T23:47:20.634761+09:00",
            "created": "2022-09-28T23:47:17.102359+09:00"
        },
        
				...,

        {
            "url": "https://www.youtube.com/watch?v=QD0by6q-9Go",
            "status": "success",
            "updated": "2022-09-28T23:58:49.095977+09:00",
            "created": "2022-09-28T23:47:17.116181+09:00"
        }
    ]
}