Yokinsoft.Rakuten.RMS.Api 2.0.0

Rakuten RMS WEB API .NET client library

楽天RMS WEB API へ接続するための .NET Framework クライアント用ライブラリです。

楽天RMSは楽天出店者が商品や注文の管理を行うウェブプラットフォームです。RMSでは出店者用にWEB APIが公開されており APIを通じて商品、注文、在庫などほとんどの管理を行うことができます。

本ライブラリは、このRMS WEB APIへ接続をサポートする .NET Framework で動作するクライアントライブラリです。Python.NET を使用すると Python から API を利用することもできます。

煩雑な通信部分、メッセージの読み書き部分を内蔵しているため、プログラマーは用途に合ったロジックの構築に集中できます。

本ライブラリは楽天RMS APIへ接続する社内受注管理システムの開発、評価のために作られました。

サーバーサイドAPIと、その仕様、関連するドキュメントは楽天が所有するものであり、それらの詳細については楽天RMS で参照してください。なお楽天RMS APIの利用について、楽天と正式な契約関係のある開発者を支援することを前提としています。

本ライブラリは楽天とは一切関係がありません。動作の安定性、整合性など、楽天の認証や監修を受けたものではありません。このライブラリについて楽天へ問い合わせ等は遠慮ください。

また、RMS APIの仕様、動作などに関する当方へのお問合せもご遠慮ください。

本ライブラリについての議論、未完成部分の実装、バグの報告・修正など、外部からのコミット(pull request等)は常に歓迎します。

履歴

• 2024-01-07 システムイベント系DLL分離とバグ修正
• 2023-11-10 全メソッドの実装
• 2023-11-01 ドキュメント類追加
• 2023-09-30 最初のコミット

Copyright and license

Copyright (c) 2023 Jake Yoshimura, Yokinsoft. Released under MIT license.

https://opensource.org/license/mit/

動作環境

• .NET Framework 4.8
• Newtonsoft Json.NET (latest version)
• (Python.NET)

使い方

詳細なドキュメントはこちら

API

ServiceProvider クラスがクライアントの認証情報とカテゴリ別のAPIへアクセスするクラスへのアクセスを提供します。

var provider = new ServiceProvider( serviceSecret, licenseKey );

serviceSecret と licenseKey はRMSのAPI設定から取得できる認証用の文字列です。

各カテゴリ別のAPI群へのアクセスは ServiceProvider のメソッドからオブジェクトを取得します。APIの分類別にアクセスするためのクラスが対応します。

API呼び出しメソッドは、基本的にサービスのエンドポイントで定義されている名前を尊重し、C# 形式、また　[動詞][目的語] (GetItemなど)の順になるように定義しなおしています。

コードサンプル

特定の注文番号を指定して注文データを取得する例

using Rakuten.RMS.Api;

var provider = new ServiceProvider( "SPxxxxxxxxxxxxxxxxx","SLxxxxxxxxxxxxxx" );
var orderApi = provider.GetRakutenPayOrderAPI();
var orderList = orderApi.GetOrder( new [] { "123456-12341234-1234567890" } );

Python から利用する方法

Python.NET を使用して Python からAPIにアクセスることができます。

Python.NET を使用して Python から使用するための環境の構築と使用方法の詳細

Python から使用では、list や パラメータのクラスオブジェクトの指定が簡単になります。

注文データの取得の例

sp = ServiceProvider('SPxxxxxxxxxxxxxxxxx','SLxxxxxxxxxxxxxx')
api = sp.GetRakutenPayOrderAPI()

orders = api.GetOrder( ["123456-12341234-1234567890"])

システム通知イベント

２種類ある通知メッセージに対応する２つのハンドラーが用意されています。いずれも、ASP.NETの HTTP ハンドラ内でメッセージの読み込みに対応します。 メッセージのハンドリングはメソッドのコールバック内で、開発者が記述します。

Rakuten.RMS.Api.SystemEventNotification.dll をプロジェクトから参照

注文通知系

public static void HandleOrderNoify(HttpRequest request, HttpResponse response, Func<OrderNotifyModel, ResultCode> handler)

システム情報系

public static void HandleSystemInfoNotify(HttpRequest request, HttpResponse response, Func<SystemNotifyModel, ResultCode> handler)

例

Notification.HandleOrderNoify(HttpContext.Current.Request, HttpContext.Current.Response,
    (model) => {
        // 任意の実装
        var orderNumbers = model.OrderInfoNotifyModel.Select(m => m.OrderNumber).ToList();
    }
);

実装状況

現在、すべてのAPIとメソッドが実装されているわけではありません。 当面は最新バージョンのAPIのみの実装を目標とします。 SOAP形式など旧来のAPIや廃止されたAPIの実装は省略します。

商品・画像管理

受注・問い合わせ管理

店舗情報

その他

TODO

• 実装はかなり進みましたが、動作検証がかなり手抜きです。
• 実装途中のプロジェクトのため、メソッドの引数、戻り値など、破壊的な変更が起こりえます。