Documentation Powered by ReDoc

hokan API (1.0.0)

Download OpenAPI specification:Download

URL: https://www.hkn.jp Terms of Service

Under Maintenance

hokan API のメンテナンス中はレスポンスステータス: 503 を返します。

クライアント側で 503 を受け取った場合に再送等の対応をお願いいたします。

Authentication

APIキー

本APIを実行するにあたり、トークンをAPI Keyとしてヘッダに付与しなければ実行ができません。

トークンは、hokan設定画面の「トークン発行機能」から発行することができます。

毎回の実行に対しトークンを付与しなければ、不正なアクセスとみなされAPIの実行ができません。

なお、サーバー側ではBasic認証として処理する為、下記の形式でトークンを送付します。

X-API-KEY: Basic <API Key>

Security Scheme Type API Key
Header parameter name: X-API-KEY

OAuth2(Internal)

本APIは権限管理処理を実現するために、内部的にOAuth2のスキームで権限管理を行います。

権限の判定を行う前に認証処理を行い、上記のAPIキーを使用します。

発行時、下記の権限のうち適切なものをトークンに付与した上で発行しなければ、APIを実行時に権限不足のためエラーが発生します。

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: N/A
Token URL: N/A
Scopes:
  • customers:read -

    Read customer information

  • customers:create -

    Create new customer

  • customers:update -

    Modify customer information

  • customer_groups:create -

    Create customer_group

  • schedules:read -

    Read schedule information

  • schedules:create -

    Create new schedule

  • schedules:update -

    Modify schedule information

  • memos:read -

    Read memo information

  • memos:create -

    Create new memo

  • memos:update -

    Modify memo information

Customers

Access to Customers

Create Customer

Create a new customer

Authorizations:
APIキーOAuth2(Internal) (customers:create)
Request Body schema: application/json

user to create

notification_users
array

通知対象のユーザーIDリスト

required
IndividualCustomer (object) or CorporationCustomer (object)

個人顧客データまたは、法人顧客データ

Responses

Request samples

Content type
application/json
{
  • "notification_users": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve a Customer

Retrieve customer details

Authorizations:
APIキーOAuth2(Internal) (customers:read)
path Parameters
id
required
int64 >= 1
Example: 12345678

顧客 ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a Customer

update a customer

Authorizations:
APIキーOAuth2(Internal) (customers:update)
path Parameters
id
required
int64 >= 1
Example: 12345678

顧客 ID

Request Body schema: application/json

customer payload

required
IndividualCustomer (object) or CorporationCustomer (object)

個人顧客データまたは、法人顧客データ
※
data に extra_values が含まれない場合、追加項目は更新されません。
data に extra_values が含まれる場合、送信されていない追加項目は削除されます。
既存の値を更新する場合、残したい追加項目の値を含んだ形で送信してください。

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Memos

Access to Memo

Create Memo

Create a new memo

Authorizations:
APIキーOAuth2(Internal) (memos:create)
Request Body schema: application/json

memo create

notification_users
array

通知対象のユーザーIDリスト

required
object (Memo)

Responses

Request samples

Content type
application/json
{
  • "notification_users": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Schedules

Access to Schedule

Create Schedule

Create a new schedule

Authorizations:
APIキーOAuth2(Internal) (schedules:create)
Request Body schema: application/json

schedule create

notification_users
array

通知対象のユーザーIDリスト

required
object (Schedule)

Responses

Request samples

Content type
application/json
{
  • "notification_users": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Schedule Free Busy

Returns free/busy information for a set of schedules

Authorizations:
APIキーOAuth2(Internal) (schedules:read)
query Parameters
time_min
required
string <datetime>
Example: time_min=2021-09-01T12:00:00+09:00

開始時刻

time_max
required
string <datetime>
Example: time_max=2021-09-02T12:00:00+09:00

終了時刻

user_ids[]
required
Array of integers
Example: user_ids[]=123456789&user_ids[]=987654321

ユーザーIDリスト

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Projects

Access to Project

Create Project Ticket

Create a new Ticket

Authorizations:
APIキーOAuth2(Internal) (tickets:create)
Request Body schema: application/json

create a ticket

required
満期更改プロジェクト (object) or 営業プロジェクト (object) or 事故プロジェクト (object) or その他プロジェクト (object)

作成するチケットの詳細データです。

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

CusomterGroups

Create CustomerGroup

Create a new customer_group or update

Authorizations:
APIキーOAuth2(Internal) (customer_groups:create)
Request Body schema: application/json

customer_group create or update

required
object

世帯データ

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}