ロゴ

Important:

This API is designed for experienced developers only and is provided as a self-service tool with minimal support.

Please be aware that currently, this API only supports legacy checkouts and classic customer accounts. It does not support integration with New Customer Accounts & new Checkout Extensibility. Shopify has not yet enabled app integration capabilities for New Customer Accounts. It is anticipated that these Shopify features will become available later in 2024. See Shopify’s consideration guide.

Fileflare API

認証

アプリで生成したAPIキーを使用してAPIで認証します。


認証方法

認証に使用するAPIキーは秘密にし、クライアント経由ではなく、サーバー側でのみ使用すること。このキーを公開すると、悪いことが起こる可能性がある。

使用される認証方法はベアラートークンです。

トークンをリクエストヘッダに追加する。

Authentication: Bearer <token>

JavaScriptの例:

ジャバスクリプト
import axios from 'axios';
axios.defaults.baseURL = 'https://app.digital-downloads.com/api/v1/';
axios.defaults.headers.common = { 'Authorization': 'Bearer Xmwm2j3EPqQOY51F1QfU6aqFHDQsB1nSTGxxII1a3c5MSYULoVBbHKZ1UL3yxntBETADT' };


// example usage
let orders = await axios.get('/orders');

リクエスト・ヘッダ

これはJSON APIです。これらのヘッダーを設定してください。

JSON
Accept: application/json
Content-Type: application/json

レート制限 - エラーコード 429

毎分60回のリクエスト。

レートリミットヘッダーは各リクエストで返される:

JSON
X-RateLimit-Limit: 15
X-RateLimit-Remaining: 14

エラー応答

401 - 認証されていません

APIキーが無効です。キーが間違っているか、失効しています。

402 - アップグレードが必要

ストレージの上限に達しました。プランをアップグレードして容量を増やしてください。

404 - 見つかりません

アクセスしようとしているリソースが見つかりません。

422 - バリデーションエラー

バリデーションエラー。

URLアセット作成時の応答例

JSON
{
    "message": "The filename is required. (and 3 more errors)",
    "errors": {
        "filename": [
            "The filename field is required.",
            "The filename name must be a string.",
            "The filename must be not be more than 255 characters."
        ],
        "size": [
            "The size field is required."
        ],
        "url": [
            "The url field is required."
        ]
    }
}

500 - サーバーエラー

サーバーのエラーはすべて自動的に弊社に直接報告されます。