サービスを利用する

JP / EN

DEVELOPER DOCS

13. APIの利用

APIについて説明します。

APIを利用するには、neqto APIサービス利用規約の全文をお読みいただいた上で、本規約に同意をしていただく必要があります。
APIは、お客さまがご利用中のcompany内にあるオブジェクトの登録・変更・削除をすることができます。
お手元のサーバやプログラム、APIクライアントソフトウェアなどから実行が可能です。
API実行には認証情報が必要となります。

認証情報取得

ログイン情報を準備します。

パラメーター 内容
Company Code 会社コード
Email ご登録のemailアドレス
Password 設定パスワード

ご利用ツールに以下の項目を設定し、認証情報取得APIを実行してください。

リクエスト

パラメーター
URL https://auth.neqto.com/account/api-token-auth
method POST
Content-Type application/json

body

1
2
3
4
5
{
"company_code": "your company code",
"email": "your login user",
"password": "your user's login password"
}

レスポンス

1
2
3
4
5
{
"token": "eyJ0eXAiOiJKV1QiLCJ...省略...9C6PW9pudTYUR-HdDI",
"language": "",
"auth_header_prefix": "JWT"
}

API実行

例としてグループ一覧取得の場合を以下に説明します。
ご利用ツールに以下の項目を設定し、グループ一覧取得APIを実行します。
Authorizationには、”jwt”+半角スペース+”認証情報取得APIのResponse dataのtokenの値”を設定します。

リクエスト

パラメーター
URL https://asia-pacific-1.neqto.com/groups
method GET
Content-Type application/json
Authorization jwt eyJ0eXAiOiJKV1QiLCJ…省略…9C6PW9pudTYUR-HdDI

レスポンス

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "group's uuid",
"name": "test",
"note": "",
"updated_at": "2018-11-16T01:58:59.705133Z",
"node_count": 0
}
]
}

API利用制限

各API実行は、1秒以上の間隔を開けて実行してください。(今後変更される可能性があります)