連携とAPI

OptiRoutesにはどのような連携があるのか？

ファイル、FTP、SFTPからの注文の読み込み

最も簡単な連携は、自社システムがすでにエクスポートしているファイルです。注文画面の配送を読み込むで、ExcelまたはCSVファイルを読み込みます。住所、顧客名、注文番号、数量などのシステムの各項目を自社の列名に一度対応付ければ、以後のファイルはすべて同じように読み込まれます。固定長TXTファイルの場合は、列名の代わりに文字位置を指定します。備考内の目印の語で行をスキップしたり、別の目印で住所を置き換えたりでき、既存の注文番号を更新するか新規として追加するかも決められます。

人手を介さないようにするには、設定で自動読み込みの方法を選びます。

• OptiRoutesファイルサーバー — 自社システムが、日付を名前にした毎日のファイルを、FTPサーバーまたは暗号化されたSFTPサーバー上の自社フォルダーに置きます。
• 自社のFTPサーバー — OptiRoutesが指定されたユーザーで接続し、当日の日付が付いたファイル、または最も新しく更新されたファイルを読み込みます。
• 自動インポートとエクスポート — 注文が自動的に読み込まれ、ルートの計画まで、クリックなしで行われます。
• ファイルAPI — 自社のソフトウェアがHTTPSで注文ファイルをアップロードします（詳しくは以下で説明します）。

顧客画面では、顧客番号、名前、住所、停車時間、開店・閉店時刻を含むExcelまたはCSVファイルで、顧客とその時間枠を作成または更新できます。

ファイルAPI：注文を取り込み、PODとレポートを出力

OptiRoutesのすべての会社には、専用の非公開ファイルフォルダーがあります。読み込む注文、写真と署名付きの署名済み納品書、ルートのエクスポート、終業時のレポートです。ファイルAPIを使えば、自社のシステムがFTPサーバーを介さずに、HTTPSで直接そのフォルダーを読み書きできます。会社の管理者は設定 → APIとファイルでFTPとAPIを切り替え、そこでキーを作成します。サポートへの依頼は不要で、新しい会社はAPIから始まります。

呼び出しでは、キーの確認、フォルダーの一覧表示、ダウンロード、アップロード（1ファイル最大50MB）、自分でアップロードしたファイルの削除、注文と種類別のある日のPODファイルの一覧表示、そしてある日のすべてのPODファイルの1つのZIPでのダウンロードができます。ガイドにはPython、C#、Node.jsのコードサンプルと、自社サーバー上のフォルダーを会社のフォルダーと同期し続けるPowerShellスクリプトが含まれているため、FTPに慣れたチームも同じ方法で作業を続けられます。詳しくはファイルAPIガイドをご覧ください。

APIキーはどのように保護されているのか？

• 最小権限 — 各キーには必要な権限だけが与えられます。署名済みPODのみ、すべてのファイルの読み取り、注文とinboxファイルのアップロードなどです。
• 許可するアドレス — キーを自社サーバーの固定IPアドレスに限定できます。
• 有効期限とローテーション — キーは一定日数で失効させることができます。新しいキーを作成して切り替えてから古いキーを無効にすれば、停止時間は発生しません。
• 即時の無効化 — 無効にしたキーは30秒以内に使えなくなります。
• 監査 — すべての呼び出しが時刻、アドレス、ファイル、応答とともに記録され、管理者に表示されます。
• 安全な保管 — OptiRoutesは各キーのSHA-256フィンガープリントのみを保存します。接続はTLS 1.2以降のHTTPSで、キーは自社の会社フォルダーにしかアクセスできません。

制限：キーごとに1分あたり300リクエスト、1ファイル50MB、1社あたり有効なキーは20個まで、1回のフォルダー一覧表示は最大5,000件です。

レポート・プッシュAPI

レポートツールやERPコネクター向けには、api-users.optiroutes.comの別のAPIが、会社のデータをレポートとして提供し、プッシュされたデータを受け付けます。OptiRoutesが会社ごとに発行する1つのアドレスと1つのトークンで、すべての呼び出しが行えます。ドキュメントページではトークンを貼り付けて、利用できるレポートとアカウントの列の対応付けを確認できます：APIドキュメントを読む。

2つのプッシュ呼び出しは逆方向に機能します。注文のプッシュはその日の注文ファイルを書き込んで自動読み込みを開始し、ドライバー、ライン、車両のプッシュは、車両ファイルと同じように車両全体を置き換えます。プッシュされたドライバーの一覧は車両全体とみなされるため、変更分だけでなく、必ずすべてのドライバーを送ってください。

ルートのエクスポートとWebhook

ルートのエクスポートでは、選択したルートをCSV、XLSX、XML、JSON、固定長TXTで書き出します。列の表でどの項目をどの見出しで出力するかを決め、注文ファイルの元の列を追加することもでき、品目管理を使う場合は2つ目のファイルにすべての品目が一覧表示されます。エクスポートは自分のパソコン、自社のFTPサーバー、会社のフォルダーに出力でき、JSONの場合はWebアドレスに送ることもできます。送信に失敗した場合、システムはもう一度だけ再試行します。

各配送をリアルタイムで受け取るには、ドライバーアプリの設定で配送レポートの送信先アドレスを入力します。ドライバーが作成したすべての配送レポートがそこにも送られ、自社のほかのシステムが自動的に更新されます。

メール、支払い、地図、メッセージング

• メール — 署名済みの納品書は、Googleのアプリパスワードを使って自社のGmailアカウントから送信されます。終業時のパレットレポートなどのレポートはレポート用のメールアドレスに届き、現金管理からは支払った顧客に領収書が、ドライバーに入金確認が送られます。
• 支払い — チャージは安全なStripeの決済ページで支払い、自動チャージ用にカードを保存することもできます。
• 住所と地図 — 住所はGoogleの候補から選び、計画の前に地図上で確認します。
• ナビゲーション — ドライバーアプリは各停車先を、住所または正確な座標で、Waze、またはiPhoneではApple Mapsに引き渡します。
• SMSとWhatsApp — 顧客への到着メッセージと追跡リンク、管理者へのアラート、協力会社へのライン、そしてWhatsAppでのドライバーへのルート画像。

よくある質問