概要¶
Guance Open API は簡素化された HTTP REST API です。
- GET / POST リクエストのみ
- リソース指向の URL を使用して API を呼び出します
- ステータスコードでリクエストの成功または失敗を示します
- すべてのリクエストは JSON 構造を返します
- Open API を使用して Guance プラットフォームにプログラムからアクセスします
サポートされるエンドポイント¶
| デプロイタイプ | ノード名 | エンドポイント |
|---|---|---|
| SaaS デプロイメント | 中国リージョン1(杭州) | https://openapi.guance.com |
| SaaS デプロイメント | 中国リージョン2(寧夏) | https://aws-openapi.guance.com |
| SaaS デプロイメント | 中国リージョン4(広州) | https://cn4-openapi.guance.com |
| SaaS デプロイメント | 中国リージョン6(香港) | https://cn6-openapi.guance.one |
| SaaS デプロイメント | 海外リージョン1(オレゴン) | https://us1-openapi.guance.com |
| SaaS デプロイメント | 欧州リージョン1(フランクフルト) | https://eu1-openapi.guance.one |
| SaaS デプロイメント | アジア太平洋リージョン1(シンガポール) | https://ap1-openapi.guance.one |
| SaaS デプロイメント | アジア太平洋リージョン2(シンガポール) | https://ap2-openapi.guance.com |
| SaaS デプロイメント | アフリカリージョン1(南アフリカ) | https://za1-openapi.guance.com |
| SaaS デプロイメント | インドネシアリージョン1(ジャカルタ) | https://id1-openapi.guance.com |
| プライベートデプロイメントプラン | プライベートデプロイメントプラン | 実際にデプロイしたエンドポイントに準拠 |
共通リクエストヘッダー(Header)¶
| パラメータ名 | 型 | 説明 |
|---|---|---|
| Content-Type | string | application/json |
| DF-API-KEY | string | 呼び出し元の識別。取得方法は API Key 管理 を参照してください。 |
認証方式¶
API は API KEY を認証方式として使用します。各リクエストでは、リクエストヘッダー内の DF-API-KEY の値を有効性の検証、および今回のリクエストのワークスペースを限定する基準(この DF-API-KEY が属するワークスペースを取得)として使用します。
現在の Open API で提供されるすべての API は、認証情報として API KEY(Header:DF-API-KEY)を提供するだけで済みます。 認証情報が存在し、かつ有効である場合、認証に成功したものとみなします。
共通レスポンス構造¶
| フィールド | 型 | 説明 |
|---|---|---|
| code | Number | レスポンス内のステータスコード。以下の例は標準 JSON レスポンスです。ダウンロードなどの API は各ページの説明に準拠します。 |
| content | String、Number、Array、Boolean、JSON | 返却データ。返されるデータ型は実際の API の業務内容によって異なります |
| pageInfo | JSON | API がページネーションを提供する場合に返されます。具体的な階層は各 API の説明に準拠します |
| pageInfo.count | Number | 現在のページのデータ量 |
| pageInfo.pageIndex | Number | ページ番号 |
| pageInfo.pageSize | Number | 1ページあたりのサイズ |
| pageInfo.totalCount | Number | 条件に一致する総データ量 |
| errorCode | String | 返されるエラーステータスコード。空の場合はエラーなしを示します |
| message | String | 返されるエラーコードに対応する具体的な説明情報 |
| success | Boolean | API の成功可否:成功は true、失敗は false |
| traceId | String | traceId。各リクエストの状況を追跡するために使用します |