こちらは、Printful APIをご利用の開発者向けの記事です。
1. 従来のAPIキーを廃止する理由は?
PrintfulでAPI開発を行う上で、APIキーの廃止は不可欠なステップと判断しました。APIキーからプライベートトークンや公開アプリへの移行することによって、PrintfulのAPIが以下の点で向上されます:
- 安全性:HTTP基本認証方法に変わってOAuth 2.0を使用することにより、完璧に近いセキュリティをご提供します。トークンのいずれかが危険にさらされた場合は直ちに削除され、APIの資格情報は保護されます。
- 多様性:生成されたトークンの権限やアクセスをカスタマイズする多くの選択肢をご提供します。
- 将来性:APIを利用するお客様のために新機能を備えています。
2. 移行の対象となるのは?
現在APIをご利用のお客様は、Printful APIを続けてご利用になるために新しいAIPトークンに切り替える必要があります。
3. 移行はいつから?
- 2022年9月30日、アカウント管理において従来のAPIキーは無効となります。
- 2023年3月30日、従来のAPIキーを利用したPrintful APIのアクセスはできません。Printful APIへのアクセスを失わないために新しいAPIトークンに切り替えていただく必要があります。新しいトークンはさらに安全性が高く、カスタマイズの幅も広くなっています。
4. 新しいAPIトークンに移行する方法は?
- 新しいAPIトークンを生成
新しいAPIトークンは、以下を使用してPrintful Developerポータルで作成できます。- プライベートトークン(特定のショップ向けに開発された機能に対して)
- 公開アプリ(Printfulの他のユーザーも使用できるアプリケーションを開発する場合)
- リクエストの認証方法を変更
新しいAPIトークンには、OAuth2.0の認証が必要です。
すべてのリクエストは、変更前の認証方法を変更する必要があります。
変更後:
変更前:
Base64でエンコードされたAPIキーを持つAuthorizationヘッダーを持つHTTP基本認証
Authorizationヘッダーにaccess_tokenとtoken_typeが含まれるOAuth2.0認証
認証方法についての詳細はこちらのAPIドキュメントをご参照ください。
5. 移行するメリットは?
OAuth2.0を使用することによって新しいAPIトークンはより安全性が高くなります。さらに、以下の点を含む多くの点で設定や管理ができるようになります:
1)識別:各トークンに名前と連絡先メールを追加
2)有効期限
3)特定のトークンで利用可能な範囲