精算照会
- 印刷する
- PDF
精算照会
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
説明
精算データを照会する。
リクエストヘッダ共通
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの * API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
| x-ncp-iam-access-key | * NAVERクラウドプラットフォームポータルまたは Sub Accountで発行された Access Key ID |
| x-ncp-apigw-signature-v2 | * 上記例の Bodyを Access Key IDとマッピングする Secret Keyで暗号化した署名 * HMAC暗号化アルゴリズムは、HmacSHA256を使用 |
精算照会 API
件別の精算データを登録する。
リクエスト URL
GET
https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/metering
リクエストパスパラメータ
| パラメータ | タイプ | サイズ | 要否 | 説明 |
|---|---|---|---|---|
| partnerId | String | 15 | Y | WORKPLACEで提供されたパートナー ID |
| companyId | String | 36 | Y | 照会する顧客会社の連携キー(CompanyId) Developers > 基本設定 > 連携キー |
リクエストボディパラメータ
| パラメータ | タイプ | サイズ | 要否 | 説明 |
|---|---|---|---|---|
| meterYm | String | 6 | Y | 精算日(YYYYMM) |
リクエスト例
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/adc835a8-244c-46b4-8410-7421816d4808/metering
GET /partner/apigw/v2/partner/{partnerId}/company/adc835a8-244c-46b4-8410-7421816d4808/metering
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"meterYm" : "202205"
}
レスポンス例
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
レスポンス
HTTPステータスコードで返され、ボディ情報として伝達する。
| HTTPステータスコード | レスポンスメッセージ | 説明 |
|---|---|---|
| 200 | OK | 一般的なリクエスト成功 |
| 201 | Created | リソース作成成功に対するレスポンスコード |
| 400 | Bad Request | 一般的なリクエスト失敗に使用 |
| 500 | Internal Server Error | - 一般的なサーバエラーに対するレスポンスコード 4XX番台のエラーコードがクライアント側のエラーを示すために使用されるのに対し、 5XX番台のエラーコードはサーバ側のエラーを示すために使用される |
レスポンス例
{
"status": 400,
"code": -4020,
"errors": [],
"message": "parentDeptExternalKey is null"
}
この記事は役に立ちましたか?