OrganizationIDの確認
設定 > APIキー一覧の 組織ID がOrganizationIDとなりますのでコピーしておきます。
Public APIでOrganizationIDを設定する
Public APIでPath Params > organizationIdを設定する場合、上記でコピーした値を入力します。
APIキーの発行
- 設定 > APIキー一覧 から、[APIキーを生成する]ボタンをクリックします。
-
「APIキーの生成」画面でAPIキー名に任意の名前を入力し、［生成する］をクリックします。
- APIキーが発行されますので、コピーして保存します。 ※Public APIを実行するために必要です。一度しか表示されませんので、ご注意ください。
Public APIでAPIキーを設定する
Public APIでCredentials > Bearerを設定する場合、上記でコピーした値を入力します。
サービスIDを確認する
“serviceId”：サービス > 対象のSaaS（Githubなど）> サービス ID から確認できます。
Public APIでエラーが表示される場合
Public APIをご利用中にエラーが表示される場合、以下を記載の上、サポートにお問い合わせください。 お問い合わせ方法はサポートへのお問い合わせもご参照ください。- ご利用のPublic APIの名称またはURL
- エラー詳細をご記載ください。
FAQ
Q. APIは日本語に切り替えできないのでしょうか？
A. UI上では言語の切り替えに対応しておりませんので、ブラウザ側の言語切り替えでご確認をお願いします。
Q. APIのカスタム項目での「Field ID Name」の設定・編集のルールはありますか？
A. カスタム項目の入力項目名には小文字の英数字と_（アンダースコア）のみ使用可能です。
カスタム項目の設定については、デバイスとディレクトリの各ヘルプページもご参照ください。
Q. APIで登録時間を指定する事はできますか？
A. APIでは、createdAt パラメータで日付、時、分を指定できます。
Q. APIで取得したデータの時刻が、管理画面の表示と一致しません。なぜですか？
A. Public APIでは、すべてのタイムスタンプを「UTC（協定世界時）」で統一しているためです。管理画面（UI）では、ローカルタイムゾーン（例：日本標準時/JST）で時刻を表示しています。一方で、APIはシステム間の連携を確実にするため、世界共通の基準であるUTCを使用します。Q. APIから取得した時刻を日本時間（JST）に直すにはどうすればよいですか？
A. お客様側で、UTCからローカルタイムゾーンへの変換処理をお願いします。APIから送受信される日付文字列は、すべてUTCとして解釈されます。例えば、日本時間（JST）はUTCより9時間進んでいるため、APIで00:00:00Z となっている場合は、日本時間では 09:00:00 となります。