目次

Admina Public APIを使用する

Yamaguchi Kaori 更新 by Yamaguchi Kaori

Admina Public API

Adminaでは取得したデータを自由に活用できるようAdmina Public APIを公開しています。

提供しているAdmina Public APIの詳細はAdmina APIドキュメントをご参照ください。

設定 > APIキー一覧の「APIドキュメント」からもご確認いただけます。

   

OrganizationIDの確認

設定 > APIキー一覧の 組織IDがOrganizationIDとなりますのでコピーしておきます。 

  

Admina Public APIOrganizationIDを設定する

Admina Public APIでPath Params > organizationIdを設定する場合、上記でコピーした値を入力します。

  

Admina Public APIキーの発行
  1. 設定 > APIキー一覧 から、[APIキーを生成する]ボタンをクリックします。
  2. 「APIキーの生成」画面でAPIキー名に任意の名前を入力し、[生成する]をクリックします。
  3. APIキーが発行されますので、コピーして保存します。
    ※Admina Public APIを実行するために必要です。一度しか表示されませんので、ご注意ください。

  

Admina Public APIでAPIキーを設定する

Admina Public APIでCredentials > Bearerを設定する場合、上記でコピーした値を入力します。

   

サービスIDを確認する

"serviceId":Adminaを開き、サービス>対象のSaaS(Githubなど)>サービス ID から確認できます。

  

Admina Public APIでエラーが表示される場合

Admina Public APIをご利用中にエラーが表示される場合、以下を記載の上、Adminaサポートにお問い合わせください。

お問い合わせ方法はAdminaサポートへのお問い合わせもご参照ください。

  • ご利用のAdmina Public APIの名称またはURL
  • エラー詳細をご記載ください。

    

FAQ

Q. Admina APIの利用ガイドはないのでしょうか?

A. Admina APIの画面上部にGUIDEがございますので、こちらをご参照ください。

  

Q. Admina APIは日本語に切り替えできないのでしょうか?

A. UI上では言語の切り替えに対応しておりませんので、ブラウザ側の言語切り替えでご確認をお願いします。

Q. Admina APIのカスタム項目での「Field ID Name」の設定・編集のルールはありますか?

A. カスタム項目の入力項目名には小文字の英数字と_(アンダースコア)のみ使用可能です。

 カスタム項目の設定についてはデバイスディレクトリの各ヘルプページもご参照ください。

 

Q. Admina APIで登録時間を指定する事はできますか?

A. Admina APIでは、 createdAt パラメータで日付を指定できます。

   

Q. APIで取得したデータの時刻が、管理画面の表示と一致しません。なぜですか?

A. Admina Public APIでは、すべてのタイムスタンプを「UTC(協定世界時)」で統一しているためです。Adminaの管理画面(UI)では、ローカルタイムゾーン(例:日本標準時/JST)で時刻を表示しています。一方で、APIはシステム間の連携を確実にするため、世界共通の基準であるUTCを使用します。

        

Q. APIから取得した時刻を日本時間(JST)に直すにはどうすればよいですか?

A. お客様側で、UTCからローカルタイムゾーンへの変換処理をお願いします。APIから送受信される日付文字列は、すべてUTCとして解釈されます。例えば、日本時間(JST)はUTCより9時間進んでいるため、APIで 00:00:00Z となっている場合は、日本時間では 09:00:00 となります。

  

Q. APIでデータを送信(POST/PATCH)する際、タイムゾーンはどう指定すべきですか?

A. 常にUTCとして送信してくださいAdmina Public APIは、送られてきた日付文字列を常にUTCとして解釈し、システムに保存します。ローカル時間をそのまま送信すると、意図しない時刻で登録される可能性があるため、必ず変換を行ってから送信してください。

この記事はお役に立ちましたでしょうか?

APIを利用してGoogle Driveのファイルをエクスポートする

Adminaにログインできない

お問い合わせ