APIの利用

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

グローバルAPIは、デバイス、ライセンス、アカウントの管理に使用されます。 グローバルAPIは単一のリージョンに限定されません。

リージョンAPIは、物理データセンターまたはアジア太平洋や北アメリカなどの場所を表します。 複数のRegionAPIがあります。 エンドポイントは、リージョン名に基づいて変更されます。 物理デバイスに最も近いリージョンを使用することをお勧めします。

エンドポイント

サービス名前エンドポイント備考
認証APIauthhttps://auth.neqto.com/
グローバルAPIglobalhttps://global.neqto.com/グローバルAPIリファレンス
AP リージョンAPIasia-pacific-1https://asia-pacific-1.neqto.com/リージョナルAPIリファレンス
NA リージョンAPInorth-america-1https://north-america-1.neqto.com/リージョナルAPIリファレンス

認証情報取得

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

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

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

リクエスト

パラメーター
URLhttps://auth.neqto.com/account/api-token-auth
methodPOST
Content-Typeapplication/json

body

{
    "company_code": "your company code",
    "email": "your login user",
    "password": "your user's login password"
}

レスポンス

このトークンの有効期限は24時間で、その時間は、 exp (エポック秒)までとなります。

{
    "token": "eyJ0eXAiOiJKV1QiLCJ...省略...9C6PW9pudTYUR-HdDI",
    "language": "",
    "auth_header_prefix": "JWT",
    "exp": 123
}

API実行

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

リクエスト

パラメーター
URLhttps://asia-pacific-1.neqto.com/groups
methodGET
Content-Typeapplication/json
Authorizationjwt eyJ0eXAiOiJKV1QiLCJ…省略…9C6PW9pudTYUR-HdDI

レスポンス

一度に返すデータは、100個までです。 100個以上のデータがある場合は、next のパラメータへリクエストしてください。

{
    "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制限があります。詳しくは、料金体系のシステム管理とデプロイメントにあるAPI制限をご確認ください。

Updated: 2022-02-17
← 前次 →