6clicks ディベロッパー向けAPIの使い始めガイド

この記事では、開発者向けに6clicks ディベロッパー向けAPIを効果的に活用するためのステップバイステップガイドを提供します。

ディベロッパー向けAPIへのアクセスの取得
ディベロッパー向けAPIの使用
認証メカニズム
APIユーザーアカウントの作成
APIキーの作成
APIキーの管理
APIキーとJWTの交換
以降のリクエストでのJWTの使用
Swaggerを使用した統合テスト（オプション）
APIドキュメントの完全版へのアクセス

ディベロッパー向けAPIへのアクセスの取得

管理者/アドバイザー/該当する権限を持つユーザーとしてディベロッパー向けAPIが表示されない場合は、インスタンスに対してAPIアクセスを有効にするために、6clicksサポートにお問い合わせください。

ディベロッパー向けAPIの使用

認証メカニズム

6clicks ディベロッパー向けAPIは、システム内のアクティブなユーザーを表すAPIキーを使用して認証を行い、セキュリティ向上のためJSON Web Token（JWT）でラップされます。JWTはユーザー情報とアクセス権限を内包し、シンプルなAPIキーに比べ、期限設定や追加のユーザーデータを含むといった利点を提供します。

APIユーザーアカウントの作成

統合の要件に応じた必要な権限を持つ専用のAPIユーザーアカウントを作成してください。このユーザーには招待を受け取るための有効なメールアドレスが必要です。

管理 > ユーザー を通じて新しいユーザーを作成
APIユーザーアカウントに適切なロールまたは権限を設定してください。 注意: 統合権限が、ディベロッパー向けAPIへのアクセスおよび次のステップでAPIキーを作成するために必要です。

APIキーの作成

APIユーザーアカウントで6clicksにログイン
メインメニューから管理＞統合に移動
一覧から 6clicks Developer API を選択し、接続をクリック
APIキーを作成 をクリック
APIキーに名前を付けます。計画している各統合ごとに個別のキーを作成することをお勧めします。
相互認証が有効になっている場合、PEM/PFX形式の証明書をアップロードして指定することも可能です。
作成をクリックして保存し、キーを必ず控えておいてください。 ※このキーは作成時にのみコピー及び保存が可能です。

APIキーの管理

APIキーは作成および削除のみ可能で、編集はできません
重要: APIキーは作成元ユーザーの代理として、そのユーザーと同じ権限を持ちます。

APIキーとJWTの交換

6clicks-Api-Key ヘッダーにAPIキーを設定し、Auth Controllerの "token" エンドポイントにPOSTリクエストを送信してください。

注意: リクエストURL内の "app-" を "api-" プレフィックスに置き換える必要があります。

例:



POST https://api-au.6clicks.io/auth-api/1.0/auth/token 
Headers: 
6clicks-Api-Key: <Your_API_Key>

APIキーの検証が成功した場合、APIプロバイダーによって署名されたJWTが返されます。このJWTにはユーザーのアクセス権限の詳細が含まれ、デフォルトで24時間の有効期限が設定されています。

例:

"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI4NTcxIiwibmFtZSI6ImdyZWcucnVkYWtvdkA2Y2xpY2tzLmNvbSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6ImdyZWcucnVkYWtvdkA2Y2xpY2tzLmNvbSIsIkFzcE5ldC5JZGVudGl0eS5TZWN1cml0eVN0YW1wIjoiUUtWTVAzWlc1RklFT0pOWk5FRjQ2SlY1QklSQ0xDWVAiLCJodHRwOi8vd3d3LmFzcG5ldGJvaWxlcnBsYXRlLmNvbS9pZGVudGl0eS9jbGFpbXMvdGVuYW50SWQiOiIxNDE4IiwianRpIjoiZDcxZWNlOGYtMDFhMC00NDg0LWJlZjktZDI5NmZmZTE4MTg5IiwiaWF0IjoxNzEyMTExNDEzLCJ0b2tlbl92YWxpZGl0eV9rZXkiOiIxYmQ0NzhmOC02ZjdmLTRmYmItYTg3Ny01MjliNTQ0OTYwMmUiLCJ1c2VyX2lkZW50aWZpZXIiOiI4NTcxIiwibmJmIjoxNzEyMTExNDEzLCJleHAiOjE3MTIxOTc4MTMsImlzcyI6IjZjbGlja3MiLCJhdWQiOiJMZWdhbFJlZ1RlY2gifQ.SfaXT7Xpr_mqr15cH7GJ5uwZPieYxHHFcSlVwImd-Ww"

以降のリクエストでのJWTの使用

Bearer方式を用いて、JWTの値を以降のAPIリクエストのAuthorizationヘッダーに含めてください。

例:

GET https://api-au.6clicks.io/assessments-api/1.0/assessments 
Authorization: Bearer <Your_JWT_Token_Value> 
Headers: 
Content-Type: application/json 
Body: 
{ 
  "sorting": "Name", 
  "maxResultCount": 10, 
  "skipCount": 0 
}