最初に実施すること

最初に実施すること

はじめに


APIを利用する為には最初にMARS Platformの管理画面にログインし、対象のアプリケーションについてのプランを契約する必要があります。
マニュアルに沿って、プラン契約を実施してください。


APIドキュメント


API利用時に事前に確認しておくべきパラメータについて

以下のパラメータについてそれぞれ確認方法、取得方法を説明します。
 

API実行時のエンドポイント

https://instant-crawler.api.mf3.marsflag.com/api/v1
詳細はINSTANT CRAWLER API ドキュメントを参照ください。

APIキー

管理画面マニュアル「3. APIキーを作成する」のを参照ください。

Webhookの設定

管理画面マニュアル「4. Webhookを設定する」のを参照ください。

API URL上のPathパラメータ

例えば以下のAPIのURLがあるとき、Pathぱパラメータとしては {contract_id} と {servicegroup_id}が相当します。
https://{エンドポイント}/contracts/{contract_id}/servicegroups/{servicegroup_id}/aaaa/bbb

この値はプラン契約時に発行され、以下の方法で確認が可能です。
まず、APIキーの作成画面を表示します。



その時、ブラウザのURLは以下のような表記になりますので{contract_id} と {servicegroup_id}が確認できます。
文字列１：{contract_id}
文字列２：{servicegroup_id}