4.4. API 利用方法¶
API 利用方法¶
API Client¶
APIをリクエストするためのツールを準備します。
| Curl | CUIでよく利用されています。 https://curl.se/ |
| Httpie | Curl の上位互換的CUIツール。API利用に適しています。 https://httpie.io/ |
| Postman | GUIでAPI利用検証するのによく利用されています。 https://www.postman.com/ |
API リクエスト例¶
API認証認可 / APIリクエスト¶
APIProxy 設定方法 にもあるとおり、以下の例となります。
以下は httpie(https://httpie.io/) を用いたリクエスト例です。
APIKey認証の例:
#APIリクエスト例
http https://{YOUR-SUB-DOMAIN}.apigwx.com/v1/sample apikey:YOUR-API-KEY
OAuthの例:
#AX OAuth token取得
http POST https://{your-sub-domain}.apigwx.com/v1/oauth/accesstokens \
grantType=client_credentials \
clientId={CONSUMER-KEY} \
clientSecret={SECRET-KEY
#OAuth token返答例
{
"accessToken": "YOUR-OAUTH-TOKEN",
"expiresIn": "86399",
"issuedAt": "1632458739411",
"scope": "",
"tokenType": "BearerToken"
}
#APIリクエスト例
http GET https://{your-sub-domain}.apigwx.com/v1/sample "Authorization: Bearer YOUR-OAUTH-TOKEN"
IdP連携の例:
#APIリクエスト例
http GET https://{YOUR-SUB-DOMAIN}.apigwx.com/v1/sample "Authorization: Bearer YOUR-IDP-JWT-TOKEN"
警告
Credentailsは、お客様にてSDPF利用規約に従い 秘匿情報として取り扱ってください。共有 および、他人に貸与してはなりません。
Credentialsが漏洩すると、お客様が指定するUpstreamに対して予想外のアクセスや、セキュリティ漏洩が発生するリスクがあります。
また、不要なCredentialsは削除し リスクを最小限に抑えて下さい
その他ツールなど¶
API操作するときに便利なツールをご紹介します。
| Jq | APIレスポンス結果のJSONデータを処理するのによく利用されます。 https://stedolan.github.io/jq/ |
| Jsonlint | GUIでJSONフォーマットの正常性の確認ができます。 https://jsonlint.com/ |
| Swagger | Open API Specに対応したAPI仕様など整備するツール群。 https://swagger.io/ |
APIレスポンス結果をJqで処理¶
サンプルとして以下になります。詳細は、上記該当リンクなどを参照ください。
OAuthのレスポンスのaccessToeknの確認:
http POST https://{your-sub-domain}.apigwx.com/v1/oauth/accesstokens \
grantType=client_credentials \
clientId={CONSUMER-KEY} \
clientSecret={SECRET-KEY | jq '.accessToken'
"YOUR-OAUTH-TOKEN"