質問
APIマネジメントで定義したAPIを外部ユーザ(HSQのアカウントを持たない)がコールすることはできますか
回答
APIマネジメントで定義したAPIをコールするには、必ずHULFT Squareのアカウントが必要となります。
エンドポイントの呼び出しのための認証にはBearer認証を使用しており、HULFT Squareのユーザー様ごとのアクセストークンが必要となるためです。
ただ、HULFT Squareのアカウントを持たない外部ユーザー様におきましても、HULFT Squareのユーザー様のアクセストークンやエンドポイントの情報があれば、ユーザー様が定義いただきましたAPIを実行することは可能です。
HSQアカウント保持者が「個人設定 > アクセストークン」からアクセストークンを生成し外部ユーザー様に提供すると、
外部ユーザー様は情報を提供いただいたユーザー様としてAPIを実行することが可能となります。
また、ユーザー様のログイン時のメールアドレス・パスワード・リフレッシュトークンを外部ユーザー様が保持している場合、
アクセストークンを更新し、リフレッシュトークンの期限までAPIを実行することが可能となります。
上記手順といたしまして、開示する必要がある情報としては以下の情報となります。
・アカウント情報(メールアドレス、パスワード)
・リフレッシュトークン
・各種エンドポイントURL(ログイン、アクセストークン、APIジョブ)
また、外部ユーザー様用にAPIコール専用のHULFTSquareユーザーを、ユーザー様にご用意いただく方法もございます。
この場合の外部ユーザー様にお伝えする情報としては、以下となります。
・LoginAPIのエンドポイント(https://app.square.hulft.com/v1/users/login)
・APIコール専用ユーザーのIDおよびパスワード
・アクセストークン更新用のエンドポイント(https://app.square.hulft.com/v1/rest-api-token)
・APIコール専用ユーザーのリフレッシュトークン
・REST APIジョブのエンドポイント
コメント
0件のコメント
記事コメントは受け付けていません。