Title here
Summary here
Below is a list of variables to configure the Platfone Firebase Backend:
| Variable | Description | Category | Advanced |
|---|---|---|---|
PLATFONE_API_URL | The URL for the Platfone API, either sandbox or production endpoint. | General | No |
PLATFONE_API_KEY | API key for the Platfone API. | General | No |
CUSTOMER_PRICE_MARKUP | Percentage markup applied to the cost of temporary phone numbers for profit. | General | No |
APPSTORE_ENABLE | Enable App Store in-app purchases as a payment option. | App Store | No |
APPSTORE_BUNDLE_ID | Unique bundle ID for your app in the App Store (e.g., com.example.app). | App Store | No |
APPSTORE_APP_ID | Numeric App ID for your app in the App Store, found in App Store Connect. | App Store | No |
APPSTORE_ENVIRONMENT | Environment for App Store purchases (Sandbox or Production). | App Store | No |
APPSTORE_PRODUCTS | JSON object with product IDs and prices in cents for App Store purchases. | App Store | No |
GOOGLE_PLAY_ENABLE | Enable Google Play in-app purchases as a payment option. | Google Play | No |
GOOGLE_PLAY_SECRET_FILE | Path to the service account key file with access to manage Google Play financial data. | Google Play | No |
GOOGLE_PLAY_PACKAGE_NAME | Package name of your app as defined in Google Play. | Google Play | No |
GOOGLE_PLAY_PRODUCTS | JSON object with product IDs and prices in cents for Google Play purchases. | Google Play | No |
CLOUD_FUNCTIONS_LOCATION | Cloud Functions deployment region, ideally close to the database for performance. | General | Yes |
CREATE_TN_CUSTOMER_ON_FIREBASE_USER_CREATE | Whether to create a customer in Platfone API when a Firebase Auth user is created. | General | Yes |
DELETE_TN_CUSTOMER_ON_FIREBASE_USER_DELETE | Whether to delete a customer in Platfone API when a Firebase Auth user is deleted. | General | Yes |
FIRESTORE_DATABASE_NAME | Name of the Firestore database for storing customer and payment data. | General | Yes |
FIRESTORE_CUSTOMERS_COLLECTION | Name of the Firestore collection for storing customer data. | General | Yes |
FIRESTORE_PAYMENTS_COLLECTION | Name of the Firestore collection for storing payment data. | General | Yes |
PLATFONE_ADMINS_FIREBASE_UIDS | Comma-separated list of Firebase UIDs for admin access to Platfone API. | General | Yes |
STRIPE_ENABLE | Enable Stripe payments for users to top up their balance. | Stripe | Yes |
STRIPE_WEBHOOK_SECRET | Secret key for verifying incoming Stripe webhook messages. | Stripe | Yes |
STRIPE_PUBLISHABLE_KEY | Stripe publishable API key for client-side purchases. | Stripe | Yes |
STRIPE_SECRET_KEY | Stripe secret API key used for creating customers and payment intents. | Stripe | Yes |
STRIPE_METADATA_PAYMENT_SOURCE | Value added to each Stripe payment intent to distinguish it for this backend. | Stripe | Yes |