背景

GakuNin RDMのAPIを使って、ファイルのアップロードなどを行う方法の備忘録です。

参考

以下でPAT（パーソナルアクセストークン）の取得方法などを説明しています。

GakuNin RDM APIをつかってみる
GakuNin RDM APIをつかってみる
ldas.jp

また以下では、OAuth (Open Authorization)を使った方法を紹介しています。Webアプリなどから使用される場合には、こちらが参考になりましたら幸いです。

NextAuth.jsを使って、ORCID・The Open Science Framework・ GakuNin RDMの認証を行う
NextAuth.jsを使って、ORCID・The Open Science Framework・ GakuNin RDMの認証を行う
ldas.jp

方法

nbdevを使って、以下のリポジトリを作成しました。

GitHub - nakamura196/grdm-tools: Tools to interact with the GakuNin RDM API
Tools to interact with the GakuNin RDM API. Contribute to nakamura196/grdm-tools development by creating an account on GitHub.
GitHub

以下でドキュメントを確認できます。

GakuNin RDM Tools – grdm-tools
Tools for working with data in an instance of GakuNin RDM (OSF)
grdm-tools

プロバイダ（osfstorage）とフォルダのID（6735a92e6dc8e1001062ac08）は変更する必要がありますが、以下のようなスクリプトにより、特定のフォルダにファイルをアップロードできます。

from grdm_tools.api import GrdmClient
import os
client = GrdmClient(
    token=os.environ.get('GRDM_TOKEN')
)
project_id = "ys86g"
file_path = "./sample.png"
url = f"https://files.rdm.nii.ac.jp/v1/resources/{project_id}/providers/osfstorage/6735a92e6dc8e1001062ac08/?kind=file"
client.upload_file(file_path, url)

ソースコードは以下からご確認いただけます。

GakuNin RDM API client – grdm-tools
Tools to interact with the GakuNin RDM API
grdm-tools

まとめ

GakuNin RDMのAPI利用にあたり、参考になりましたら幸いです。

動画版（生成AIによる自動生成）: この記事の内容をずんだもん×四国めたんの掛け合いで解説しています。自動生成のため、内容に誤りがある可能性があります。正確な情報は記事本文をご参照ください。