Senses Open API References (v1)

Download OpenAPI specification:Download

Overview

Sensesユーザ向けAPIです。本ドキュメントを確認頂き、ご利用ください。
また随時APIは拡張していきますので、ご希望のものがない場合は右下のチャットサポートからリクエストください。今後の開発の参考とさせて頂きます。

本APIはベータ版です。仕様などが変更になる可能性がありますのでご了承ください。

Introduction

Endpoints

APIのエンドポイントのベースURLは以下になります。バージョンの v1 も含めてリクエストしてください。
{PATH_TO_REQUEST} は利用するAPIのパスを指定してください。

https://senses-open-api.mazrica.com/v1/{PATH_TO_REQUEST}

Requests Limit

APIのリクエストには以下の制限があります。制限を超過した場合は 429 Too Many Requests がレスポンスされます。

  • 3000リクエスト / 日
    • リクエスト数のリセットタイミングは UTC となります
  • 3リクエスト / 秒 (バースト 100)
    • トークンバケット 方式を利用した仕組みとなります

Sort

リストを返す API では、要素が「更新日時の降順」でソートされて返ってきます。ソート順を変更するには sort パラメータに並び替えのキーとなるプロパティを指定します。キーの前に - (ダッシュ) をつけると 降順 となります。以下を参考にしてください。

  • 更新日時の昇順でソートする場合
https://senses-open-api.mazrica.com/v1/customers?sort=updatedAt
  • 複数指定も可能(更新日時の降順かつidの昇順)
https://senses-open-api.mazrica.com/v1/customers?sort=-updatedAt,id

Authentication

X-Api-Key

APIの利用には APK Key が必要です。以下をご参考にSensesの管理機能から API Key を発行できます。APIをリクエストする際、発行した API Key をリクエストに含めてください。

  • オンラインマニュアル: SensesAPIを利用する – Senses
  • 以下のように生成した APK Key を リクエスト時のヘッダで X-Api-Key に指定してください
curl -X GET \
  http://senses-open-api.mazrica.com/v1/domains/settings \
  -H 'X-Api-Key: YOUR_API_KEY'
Security scheme type: API Key
header parameter name: X-Api-Key

チーム(Domains)

チーム設定情報取得

  • 所属しているチームの設定情報を取得
Authorizations:

Responses

200

OK

404

Not Found

500

Internal Server Error

get /domains/settings
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/domains/settings

Response samples

application/json
Copy
Expand all Collapse all
{
  • "dealTypes":
    [
    ],
  • "users":
    [
    ]
}

取引先(Customers)

取引先情報リスト

  • 取引先の情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
sort
string

並び順 ソート可能 updatedAt

updatedAtFrom
string <date-time>
Example: "2018-04-01T10:30:00"

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>
Example: "2018-04-01T10:30:00"

更新日時による検索範囲(終了)

  • ex) 2018-04-01T10:30:00
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /customers
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/customers

Response samples

application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "customers":
    [
    ]
}

取引先情報登録

  • 取引先情報を新規に登録します
  • 登録後の取引先IDをレスポンスとして返します
Authorizations:
Request Body schema: application/json
name
required
string

取引先名

address
string

住所

telNo
string

電話番号

webUrl
string

URL

employee
integer

従業員数

capital
integer

資本金

closingMonth
integer [ 1 .. 12 ]

決算月(1〜12)

cutomerCustoms
Array of object

取引先詳細項目

Responses

201

Created

500

Internal Server Error

post /customers
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/customers

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 1,
  • "cutomerCustoms":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms":
    [
    ]
}

取引先情報

  • 取引先情報を取得
Authorizations:
path Parameters
id
required
integer

取引先ID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /customers/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/customers/{id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms":
    [
    ]
}

取引先情報更新

  • 取引先情報を更新
Authorizations:
path Parameters
id
required
integer

取引先ID

Request Body schema: application/json
name
required
string

取引先名

address
string

住所

telNo
string

電話番号

webUrl
string

URL

employee
integer

従業員数

capital
integer

資本金

closingMonth
integer [ 1 .. 12 ]

決算月(1〜12)

cutomerCustoms
Array of object

取引先詳細項目

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /customers/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/customers/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 1,
  • "cutomerCustoms":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms":
    [
    ]
}

取引先情報削除

  • 取引先情報を削除
  • 取引先に紐づく案件、アクション、コンタクトは全て削除されます
Authorizations:
path Parameters
id
required
integer

取引先ID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /customers/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/customers/{id}

案件(Deals)

案件情報リスト

  • 案件情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
sort
string

並び順 ソート可能 updatedAt

updatedAtFrom
string <date-time>
Example: "2018-04-01T10:30:00"

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>
Example: "2018-04-01T10:30:00"

更新日時による検索範囲指定(終了)

  • ex) 2018-04-01T10:30:00
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /deals
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/deals

Response samples

application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "deals":
    [
    ]
}

案件情報登録

  • 案件情報を新規に登録します
  • 登録後の案件IDをレスポンスとして返します
  • 案件IDに該当する案件が存在しない場合は、登録エラーとなります
  • フェーズ、商品、契約確度、チャネル、ユーザー、最終停止理由、案件詳細項目、商品内訳に関するパラメータは、チーム設定情報取得APIで取得できる情報を指定する必要があります
  • IDがSenses上に存在しない、異なる案件タイプ用のIDが設定されている等、データに不整合がある場合、登録エラーとなります
  • 案件詳細項目の四則演算タイプの登録には対応していません
Authorizations:
Request Body schema: application/json
name
required
string

案件名

amount
integer

契約金額

expectedContractDate
required
string <date>

契約予定日

reason
string

最終停止理由

dealType
required
object

案件タイプ

endPhaseReasonIds
Array of integer

最終停止理由ID 配列

customer
required
object

取引先

phase
required
object

フェーズ

product
required
object

商品

probability
required
object

契約確度

channel
required
object

チャネル

user
required
object

ユーザー

dealCustoms
Array of object

案件詳細項目

dealProductDetails
Array of object

商品内訳

Responses

201

Created

500

Internal Server Error

post /deals
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/deals

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "amount": 0,
  • "expectedContractDate": "2018-04-11",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasonIds":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "dealCode": "string",
  • "amount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2018-04-11",
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasons":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

案件情報

  • 案件情報を取得
Authorizations:
path Parameters
id
required
integer

案件ID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /deals/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/deals/{id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "dealCode": "string",
  • "amount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2018-04-11",
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasons":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

案件情報更新

  • 案件情報を更新
Authorizations:
path Parameters
id
required
integer

案件ID

Request Body schema: application/json
name
string

案件名

amount
integer

契約金額

expectedContractDate
string <date>

契約予定日

reason
string

最終停止理由

dealType
object

案件タイプ

endPhaseReasonIds
Array of integer

最終停止理由ID 配列

customer
object

取引先

phase
object

フェーズ

product
object

商品

probability
object

契約確度

channel
object

チャネル

user
object

ユーザー

dealCustoms
Array of object

案件詳細項目

dealProductDetails
Array of object

商品内訳

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /deals/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/deals/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "amount": 0,
  • "expectedContractDate": "2018-04-11",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasonIds":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "dealCode": "string",
  • "amount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2018-04-11",
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasons":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

案件情報削除

  • 案件情報を削除
  • 案件に紐づく案件、アクションは全て削除されます
Authorizations:
path Parameters
id
required
integer

案件ID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /deals/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/deals/{id}

コンタクト(contacts)

コンタクト情報リスト

  • コンタクトの情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
sort
string

並び順 ソート可能 updatedAt

updatedAtFrom
string <date-time>
Example: "2018-04-01T10:30:00"

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>
Example: "2018-04-01T10:30:00"

更新日時による検索範囲(終了)

  • ex) 2018-04-01T10:30:00
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /contacts
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/contacts

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

コンタクト情報登録

  • コンタクト情報を新規に登録します
  • 登録後のコンタクト情報をレスポンスとして返します
Authorizations:
Request Body schema: application/json
name
required
string

コンタクト名

email
string Nullable

メールアドレス

tel
string Nullable

電話番号

mobileTel
string Nullable

携帯電話番号

address
string Nullable

住所

dept
string Nullable

部署

position
string Nullable

役職

memo
string Nullable

メモ

customer
object Nullable

取引先

contactCustoms
Array of object

コンタクト詳細項目

Responses

201

Created

500

Internal Server Error

post /contacts
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/contacts

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "customer":
    {
    },
  • "contactCustoms":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "marketoLeadScore": 0,
  • "customer":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "contactCustoms":
    [
    ]
}

コンタクト情報

  • コンタクト情報を取得
Authorizations:
path Parameters
id
required
integer

コンタクトID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /contacts/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/contacts/{id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "marketoLeadScore": 0,
  • "customer":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "contactCustoms":
    [
    ]
}

コンタクト情報更新

  • コンタクト情報を更新
Authorizations:
path Parameters
id
required
integer

コンタクトID

Request Body schema: application/json
name
string

コンタクト名

email
string Nullable

メールアドレス

tel
string Nullable

電話番号

mobileTel
string Nullable

携帯電話番号

address
string Nullable

住所

dept
string Nullable

部署

position
string Nullable

役職

memo
string Nullable

メモ

customer
object Nullable

取引先

contactCustoms
Array of object

コンタクト詳細項目

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /contacts/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/contacts/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "customer":
    {
    },
  • "contactCustoms":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "marketoLeadScore": 0,
  • "customer":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "contactCustoms":
    [
    ]
}

コンタクト情報削除

  • コンタクト情報を削除
Authorizations:
path Parameters
id
required
integer

コンタクトID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /contacts/{id}
The Open API Service by Senses
https://senses-open-api.mazrica.com/v1/contacts/{id}