FlipLink APIでの認証

はじめに

FlipLink APIへのすべてのリクエストは、APIキーで認証します。X-Api-KeyヘッダーまたはBearerトークンとして送信し、Who Am Iでどのアカウントのキーかを確認できます。

このディスカッションで使うAPI

GETWho Am I/api/whoami

このガイドに誤りや古い情報がありますか？

できること

FlipLink APIへの各呼び出しは、APIキーを通じてアカウントに紐づいています。このガイドでは、リクエストでそのキーを送る方法と、キーがどのアカウントのものかを確認する方法を説明します。

ベースURL

すべてのAPIリクエストの送信先は次のとおりです。

https://go.fliplink.me

APIキーの送信

リクエストの認証には、次の2つの方法のどちらかを使えます。どちらも利用できます。

X-Api-Keyヘッダー:

curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'X-Api-Key: YOUR_API_KEY'

Authorization: Bearerヘッダー:

curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'Authorization: Bearer YOUR_API_KEY'

お使いのHTTPクライアントに合う方を選んでください。以降のガイドでは、一貫性のためにX-Api-Keyを使用します。

キーがどのアカウントのものかを確認する

GET /api/whoamiは、そのキーを所有するアカウントを返します。キーが有効かどうかの確認や、プランの最大アップロードサイズの確認に役立ちます。

curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'X-Api-Key: YOUR_API_KEY'

レスポンス:

{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

MaxFileSizeMBは、プランの最大アップロードサイズをメガバイト単位で表したものです。

認証に失敗したとき

キーが欠けているか無効な場合、APIはHTTP 401を返し、プレーンなUnauthorized HTMLページを返します。JSONボディはありません。キーが正しいこと、そして上記2つのヘッダーのいずれかで送られていることを確認してください。

キーは非公開にする

APIキーはアカウントを識別するものなので、サーバーサイドのコードからのみ送信してください。訪問者に読み取られる可能性があるクライアントサイドやブラウザのコードには、決して埋め込まないでください。