第2章接続先

2.1Web API 利用時の認証について

WebAPIを利用するには事前に認証に関する情報を申請し、それに応じた適切なクエリパラメータ及びHTTPSヘッダを付加してAPIを実行する必要があります。認証がエラーとなった場合はAPIを利用することができません。

WebAPIで使用する認証方式は、OAuth認証です。

OAuth認証(2-legged)を使用する場合は「クライアントID」と「秘密鍵」が発行されます。これらを用いてOAuth署名を利用者側で生成し、API実行時に付加することで認証を行います。

OAuth認証使用時に必要となるクエリパラメータを以下に記載します。

※利用するサービスアカウントのクライアントID、秘密鍵を使用してください。詳細はサービス管理者に問い合わせをしてください。

上記のパラメータをhttps://ドメイン名/oauth2/tokenに対してPOSTしてください。

※接続先のドメイン名はサーバーによって異なります。詳細は、サービス管理者にお問い合わせください。

以下のパラメータがレスポンスされます。


パラメータ名	データ型	説明
access_token	String	発行されたアクセストークンが入ります。
expires_in	int	アクセストークンの有効時間(単位：秒)が入ります。
refresh_token	String	リフレッシュトークが入ります。アクセストークンの有効時間を伸ばす時に使用します。
scope	String	スコープタイプが入ります。
token_type	String	アクセストークンの型が入ります。

各API利用時には、アクセストークンをヘッダー部に付与してください。

アクセストークンの有効時間が切れると、再度アクセストークンを取得する必要があります。再取得時は、下記のURLにリクエストをPOSTする必要があります。

https://ドメイン名/oauth2/token

リクエストパラメーターは下記の通りです。


パラメータ名	必須	データ型	デフォルト	説明
grant_type	○	String	refresh_token	固定値のrefresh_tokenを指定してください。
refresh_token	○	String	-	認証のレスポンスで送られてきたrefreshtoken値を指定してください。
client_id	○	String	-	事前に発行されたクライアントIDを指定してください。
client_secret	○	String	-	事前に発行された秘密鍵を指定してください。

認証エラーが起きた場合、アクセストークンが返ってきません。
エラーの詳細に関しては、状態コードとエラーをご確認下さい。