Track Shipping Labels with ShipEngine
Made by ShipEngine
ラベル追跡データを取得するための呼び出し可能な https 関数と、ShipEngine アカウントからの更新をライブ トラッキングするための https Webhook エンドポイントを提供します。
この拡張機能の動作
この拡張機能を使用すると、有効な荷物追跡番号とサポートされている配送業者コードまたは ShipEngine ラベル ID を使用して、配送業者から最新の追跡データを取得できます。
この拡張機能が呼び出される関数呼び出しの例を以下に示します。
import { initializeApp } from 'firebase/app'; import { getFunctions, httpsCallable } from 'firebase/functions'; const app = initializeApp({ projectId: '### CLOUD FUNCTIONS PROJECT ID ###', apiKey: '### FIREBASE API KEY ###', authDomain: '### FIREBASE AUTH DOMAIN ###', }); const functions = getFunctions(app); const trackLabel = httpsCallable(functions, 'trackLabel'); trackLabel({ trackingNumber: '9405511899223197428490', carrierCode: 'stamps_com', }).then((result) => { // Read result of the Cloud Function. /** @type {any} */ const data = result.data; });
追加の設定
この拡張機能をインストールする前に、Firebase プロジェクトで Cloud Firestore データベースを設定していることを確認してください。
また、ShipEngine アカウントを作成するか、既存のアカウントを使用する場合は、この拡張機能を設定するときに ShipEngine API Management ページから ShipEngine API Key を提供する必要があります。
料金
拡張機能をインストールするには、プロジェクトを Blaze(従量課金制)プランに含める必要があります。
- この拡張機能に必要な Firebase リソースに対しては、使用しない場合でも、小額(通常は約 $0.01/月)が請求されます。
- この拡張機能は、次のような他の Firebase サービスや Google Cloud Platform サービスを使用するため、こうしたサービスの無料枠を超えた場合には関連する料金が発生します。
- Cloud Firestore
- Cloud Functions(Node.js 15 を超えるランタイム。FAQ を参照)
- Cloud Secret Manager
この拡張機能を使用するには、ShipEngine アカウントも必要です。ShipEngine アカウントの利用に関連する費用については、すべてお客様の負担となります。
この拡張機能をインストールする方法
Firebase CLI の使用
拡張機能のインストールと管理は、Firebase CLI でも行えます。
ステップ 1: 以下の npm コマンドを実行して、CLI をインストールするか、最新バージョンの CLI に更新します。
npm install -g firebase-tools正常に機能しない場合は、Firebase CLI リファレンスを確認するか、npm のアクセス権を変更してください。
ステップ 2: 新しい Firebase プロジェクトのディレクトリを設定するか、既存のプロジェクト ディレクトリに移動します
ステップ 3: 次を実行して、この拡張機能を拡張機能のマニフェストに追加します
firebase ext:install shipengine/track-labels --local --project=projectId_or_alias
ステップ 4(任意): Firebase Emulator Suite を使用して、この拡張機能をローカルでテストします
firebase emulators:start
ステップ 5: マニフェストにある拡張機能をプロジェクトにデプロイします
firebase deploy --only extensions --project=projectId_or_alias