1. API仕様

1. API仕様

データ連携API 仕様​

1.1 アップロードURL取得方法

項目

説明

ホスト

di-contract.api.mf3.marsflag.com

ベースパス

/api/v1/data_integration_public_service/

プロトコル

https

メソッド

POST

パス

/upload/contracts/{contract_id}/servicegroups/{servicegroup_id}/services/{service_id}/file_type/{file_type_dtype_id}

リクエストヘッダ

x-mf-apikey: (APIキー)


1.2 パスのパラメータ仕様

項目

説明

contract_id

契約ID

検索サービス作成時にシステム側にて一意に決定

servicegroup_id

サービスグループID

service_id

サービスID

file_type_dtype_id

ファイルタイプ

ファイルタイプ：

10010 ドキュメントデータ

10020 カテゴリーデータ

10030 ドリルダウンデータ

1.3 応答：アップロードURL取得

項目

レスポンス内容

データ型

説明

Content-Type

application/json

text


201

Created

status

String

“OK”

message

String

“success.”

contents

Object



upload_url

String

アップロードURL

※ 本URLに対し、メソッドPUTでファイルをアップロードします。

リクエストから1時間有効

400

Bad Request

status

String

“NG”

message

String

エラー要因

404

Not Found

status

String

“NG”

message

String

エラー要因

500

Internal Server Error

status

String

“NG”

message

String

エラー要因