hokan API v2

hokan API v2には、https://api.hokan.io/api/ext/v2/でアクセスします。

認証

APIの認証には、リクエストヘッダにWebAPIトークンをAPIキーとして付与する必要があります。
このトークンは、hokan設定 > WebAPIトークン管理の「トークンを追加」で発行できます。
各リクエストにトークンを添付しない場合はアクセスが拒否されます。

curl -H "X-API-KEY: Basic $TOKEN" "https://api.hokan.io/api/ext/v2/users"

Webトークン発行時に設定してください。
API実行時は、設定されたユーザーの操作として記録されます。

付与する権限によって、実行する操作を制限することができます。
v1権限のみ付与されたトークンでは、hokan API v2は実行できません。

一覧取得のエンドポイントは、1回のリクエストで最大100件まで取得されます。
totalが100件を超える場合は、pageを指定して取得してください。

メモ・予定・ToDoでは、関連する顧客・契約・プロジェクトチケットのIDをrelationsで取得できます。
relationsのobject_idは、roleの値により対応するオブジェクトIDが決まります。

リソース	role	object_id
メモ	`POLICY_MEMO`	契約ID
メモ	`MANUAL_POLICY_MEMO`	申込ID
メモ	`INDIVIDUAL_CUSTOMER_MEMO`	顧客ID (個人)
メモ	`CORPORATE_CUSTOMER_MEMO`	顧客ID (法人)
メモ	`PROJECT_TICKET`	プロジェクトチケットID
予定	`POLICY_CALENDAR`	契約ID
予定	`MANUAL_POLICY_CALENDAR`	申込ID
予定	`INDIVIDUAL_CUSTOMER_CALENDAR`	顧客ID (個人)
予定	`CORPORATE_CUSTOMER_CALENDAR`	顧客ID (法人)
予定	`PROJECT_TICKET_CALENDAR`	プロジェクトチケットID
ToDo	`POLICY_TODO`	契約ID
ToDo	`MANUAL_POLICY_TODO`	申込ID
ToDo	`INDIVIDUAL_CUSTOMER_TODO`	顧客ID (個人)
ToDo	`CORPORATE_CUSTOMER_TODO`	顧客ID (法人)
ToDo	`PROJECT_TICKET_TODO`	プロジェクトチケットID