こんにちは。CData Software Japanリードエンジニアの杉本です。

今回の記事ではCData NetSuite Driverの重要な変更点についてのお知らせです！

最新のCData NetSuite Driverでは、NetSuite APIの最新バージョン「2020.2」に対応しました。

www.netsuite.com

CData NetSuite Driverでは、接続文字列オプションの一覧にある「Version」から、接続対象となっているNetSuite APIバージョンを確認できます。

このバージョンで最も重要なアップデートは「NetSuite ReleaseNotes_2020.2.0_ja_JP.pdf」の83～84ページに掲載されている「ユーザー資格情報からのSOAP Webサービス認証の廃止」です。

NetSuite DriverではSuiteTalkと呼ばれるSOAPベースのAPIを軸として機能を提供しているのですが、この2020_2 バージョンからUserId・PWを用いたAPI接続ができなくなりました。

詳しくは以下の主要な変更点をご覧ください。

http://cdn.cdata.com/help/DNF/jp/odbc/pg_changes.htm

ログインとセッションの変更の廃止

NetSuiteの2020.1リリース以降、ログイン/ログアウト要求を介してAPIとのセッションを確立できなくなりました。 これにより、接続プロパティUseSessionsが廃止されたため、削除する必要がありました。 これは、セッションの同時実行性を利用するために使用される個々の統合を強制するNetSuiteの変更の一部です。 これは、ユーザー認証とパスワード認証を同時にリクエストと一緒に使用することができなくなったことを意味します。

代わりに、同時リクエストを利用したい場合は、トークンベースの認証またはOAuthを使用する必要があります。 現在ユーザー/パスワードを使用している場合は、OAuth認証の使用への切り替えを確認することをお勧めします。 NetSuiteで統合を作成したら、統合に指定したものと一致するようにMaximumConcurrentSessionsを設定するだけです。

そのため、この記事ではこの変更により発生する問題、およびその対処方法について、お伝えします。

接続例にはCData JDBC Driverを用いていますが、ODBC・ADO.NET・Excel Add-inなど、すべて共通となります。

既存の認証方法で2020_2 バージョンのAPIに接続した場合どうなるのか？

まず、既存のユーザーID・PWを用いた認証では具体的にどんな問題に遭遇するのか？　問題が発生するユーザーID・PWと2020_1バージョンのAPIを用いて確認してみましょう。

なお、接続に成功した場合は、以下のようにNetSuite上のテーブル（エンティティ）一覧とそのデータが取得できます。

エラーが発生する指定ですが、以下のようにUser・Passwordの項目と共にVersionの項目で「2020_2」を指定します。

これで接続を試してみると、以下のように「Invalid authentication.」エラーが発生しました。

これが最新バージョンのAPIでUser・Passwordによる認証ができない場合のエラーメッセージになります。

具体的なエラーレスポンスは以下のようになっています。

xml version="1.0" encoding="UTF-8"?>
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    
        
            
                soapenv:Server.userException
            
            
                Invalid authentication.
            
            
                xmlns:platformFaults="urn:faults_2020_2.platform.webservices.netsuite.com">
                    
                        USER_ERROR
                    
                    
                        Invalid authentication.
                    
                
                xmlns:ns1="http://xml.apache.org/axis/">
                    partners018
                
            
        
    

ちなみにVersionだけ「2020_1」に変更すると、以下のように接続することが可能です。

2020_2 バージョンのAPIに変更する場合に必要な対処方法

具体的なエラー内容がわかったところで対象方法を確認してみましょう。

NetSuite DriverではUser・Passwordによる認証を含めて、現在3種類の認証方法をサポートしています。

2020_2以降のバージョンで接続する際には、OAuth認証とトークンベース認証を用いた接続への切替が必要となります。すでにこのOAuth認証もしくはトークンベース認証を使用していれば、特に設定の変更は必要ありません。

ちなみに、OAuth認証では、接続時にブラウザによるユーザーのログインとアクセス許可を求めるアプローチとなるため、そういったUIによる設定が可能な環境やアプリケーションで実施する必要があります。

環境によってはOAuthがやりづらいことがあると思うので、その場合はトークンベース認証を行うのが良いでしょう。

OAuth認証

それではまずOAuth認証を試してみましょう。

cdn.cdata.com

OAuth認証を行うためには、対象のNetSuiteの環境にて「統合」の設定を追加する必要があります。

NetSuiteにログインして、設定マネージャーに移動し、インテグレーションの「統合を管理」から「新規作成」をクリックします。

統合作成画面では、以下のように設定を行います。

必要なプロパティを入力後、保存をクリックすることで、接続の際に必要となるコンシュマーキー（消費者とついていますが）とコンシュマーシークレットが入手できます。

これは初回しか表示されないので注意しましょう。

あとは、生成されたコンシュマーキーとコンシュマーシークレットを用いて、以下のようにDriverの接続プロパティを入力するだけです。

これでログインを試みると、以下のようにブラウザが立ち上がり、アクセス許可を求める画面が表示されます。内容を確認して、許可をクリックしてください。

接続完了後、データにアクセスができるようになります。

トークンベース認証

トークンベース認証は、OAuth認証を土台としながら、予めNetSuiteの管理画面からアクセス用のトークンを取得して接続する方法です。

http://cdn.cdata.com/help/DNF/jp/odbc/pg_createinui.htm

実はOAuth認証でも内部ではトークンの取得を行っているので、UI上で予め作成するのか、プログラム側で任意のユーザーを選ばせるのか？だけの違いしかありません。

手順はOAuthの時と同じように、予め「統合」の設定を作成しておく必要があります。

統合を作成後、同じようにコンシュマーキーとコンシュマーシークレットが表示されるので、控えておきましょう。

次にロールの管理画面から、新しいロール・もしくは既存のロールを編集し、トークンベース認証に必要な設定を付与します。

必要な設定は「SOAP Webサービス」「アクセストークンの管理」「ユーザーアクセストークン」の3種類です。そして、このロールをトークンベース認証で接続するユーザーに付与してください。

最後にユーザー／ロールの「アクセストークン」画面から新しいアクセストークンの作成を行います。

予め作成したアプリケーションを選択し、先程構成したロールおよびそのロールが紐付けられたユーザーを選択して、保存します。

保存が完了すると、以下のトークンIDとトークンシークレットが表示されるので、これを控えておきます。

あとは接続プロパティで生成した情報を以下のように設定するだけです。

今回はOAuth認証の時のように、ブラウザを用いたログインは行われず、そのまま接続が完了します。

補足① 以前のバージョンについて

ユーザーID・PWが利用できる2020_1までのバージョンですが、現状すぐに廃止されるわけではないようです。

2020/10/28 時点で公式のヘルプを参照したところ、SuiteTalk 2009.2のバージョンのサポートは終了するようですが、2020.1 については現在触れられていませんでした。

補足② UseSessionsプロパティの廃止について

このバージョンの変更に伴い、CData NetSuite Driver 2019バージョンまで提供していたUseSessionsプロパティが廃止になりました。

今後はMaximum Concurrent Sessionsのプロパティのみ使用しますが、2020_1のバージョンからはAccountId・ApplicationIdに基づいて自動的に設定されます。

http://cdn.cdata.com/help/DNF/jp/odbc/RSBNetSuite_p_MaximumConcurrentSessions.htm

おわりに

おそらく今まではユーザーID・PWによる接続を行っている方々がほとんどかと思いますので、かなり影響が大きい変更になっていました。

すぐに使えなくなる機能ではありませんが、最新バージョンのDriverを利用する際にはご注意ください。

また、もし本内容についてご質問・ご相談がありましたら無償のテクニカルサポートまでお気軽にお問い合わせください。

https://www.cdata.com/jp/support/submit.aspx

関連コンテンツ