API認証

ここに掲載されている内容は、開発者用の技術情報です。
掲載内容以上のサポートはできません。
ご利用にあたっては十分なご理解の上で活用ください。
SuperSaaSは開発中を含むwebhookとAPIを提供するもので、それを利用するサービス、アプリケーションに責任を持つことはできません。

認証するためにはアカウント情報の下部にあるAPIキーが必要です。APIはいくつかの種類の認証をサポートします。:

クエリパラメーター: サーバー間通信では、アカウント名とAPIキーをURLパラメーターとして送信できます。 APIキーをクリアテキストで送信している場合は、SSL (https) 暗号化接続を介してAPIにアクセスすることをお勧めします。アカウントのAPIキーをcallに含めることは、ページのHTMLソースを見ている人には自分のAPIキーが明らかになるため、クライアントブラウザからAPIにアクセスするときに行ってはいけません。
HTTP基本認証: リクエストヘッダーにアカウント名とAPIキーを入力できます。この場合、「ユーザー名」はあなたのアカウント名であり、「パスワード」フィールドはあなたのAPIキーを含むべきです。More info
チェックサム: クライアントサイドスクリプトからのAPI呼び出しを容易にするために、MD5ハッシュで認証することができます。ハッシュは、アカウント名、APIキー、およびユーザー名を含む連結文字列から計算されます（ユーザーデータを含む要求の場合のみ）。計算にはあなたとSuperSaaSだけが知っているAPIキーを使用するため、他人により計算はできません。チェックサムにはユーザー名が含まれているため、訪問者ごとに異なり、ブラウザで実行するために安全にAJAX callを組み入れることができます。ほとんどの言語はMD5ハッシュを計算する簡単な方法を提供します。:

ユーザーAPIとアポイントメントAPIでのチェックサム例

PHP: $user = "user_name@example.com";$checksum = md5("Your_account_nameYour_API_key$user")
Ruby: checksum = Digest::MD5.hexdigest("Your_account_nameYour_API_key#{'user_name@example.com'}")
Python: checksum = hashlib.md5(("Your_account_nameYour_API_key%s" % "user_name@example.com").encode()).hexdigest()

フォームAPIでのチェックサム例

PHP: $user = 'user_name@example.com';$checksum = md5("Your_account_nameYour_API_key")
Ruby: checksum = Digest::MD5.hexdigest("Your_account_nameYour_API_key")
Python: checksum = hashlib.md5("Your_account_nameYour_API_key".encode()).hexdigest()

現在、すべての認証方法はAPIキーの代わりに管理者パスワードを使用しても機能します。これは旧式の統合をサポートするためのものですが、今後のためにAPIキーに切り替えることをお勧めします。