Track Shipping Labels with ShipEngine
Made by ShipEngine
ラベル追跡データを取得するための呼び出し可能な https 関数と、ShipEngine アカウントからの更新をライブ トラッキングするための https Webhook エンドポイントを提供します。
この拡張機能の動作
Use this extension to retrieve up-to-date tracking data for any shipment from any carrier using a valid tracking number and a supported carrier code or a ShipEngine label ID.
Here's an example function call that would trigger this extension:
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;
});
Additional setup
Before installing this extension, make sure that you've set up a Cloud Firestore database in your Firebase project.
You must also create a ShipEngine account or use your existing account and supply your ShipEngine API Key from the ShipEngine API Management page when you configure this extension.
Billing
To install an extension, your project must be on the Blaze (pay as you go) plan
- You will be charged a small amount (typically around $0.01/month) for the Firebase resources required by this extension (even if it is not used).
- This extension uses other Firebase and Google Cloud Platform services, which have associated charges if you exceed the service’s free tier:
- Cloud Firestore
- Cloud Functions (Node.js 15+ runtime. See FAQs )
- Cloud Secret Manager
Usage of this extension also requires you to have a ShipEngine account. You are responsible for any associated costs with your usage of your ShipEngine account.
この拡張機能をインストールする方法
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
Step 4 (Optional): Test this extension locally with the Firebase Emulator Suite
firebase emulators:start
ステップ 5: マニフェストにある拡張機能をプロジェクトに デプロイ します
firebase deploy --only extensions --project=projectId_or_alias