-
Notifications
You must be signed in to change notification settings - Fork 1
Home
alxspiker edited this page Feb 24, 2024
·
12 revisions
Comprehensive documentation and development resources for building robust applications on the Pi Network. Enhance your understanding of Pi's APIs, SDK, and best practices to create seamless user experiences.
- Pi Network API Documentation: Explore API endpoints for managing pioneer data, payments, and more Server API
- Pi App Platform SDK Guide: Learn to integrate Pi functionality directly into your app Platform SDK
- Development Checklist: Follow our checklist for a smooth development process Checklist
Let's build great Pi Network applications together!
Follow these steps to register, configure, and launch your Pi Network app.
-
Download the Pi App:
- Google Play Store Link
- Apple App Store Link
-
Register for an account: Use my referral code (insert code here) to get 1 Pi and support this project!
-
Download and Sign into the Pi Browser:
- See our video tutorial...
- Google Play Store Link
- Apple App Store Link
-
Verify Email Address: (Required)
- Enter the Pi Mining App, click the ‘☰’ menu, and select "Profile".
-
Register your App and Configure Hosting:
- Enter App Name, Description, and select the Network (See our Pi Mainnet vs Testnet Page).
- Set up hosting on a third-party provider or Pi Network's Pi Engine.
-
Create a Wallet:
- Create a wallet at wallet.pi. Confirm access before continuing.
-
Code and Configure Your App
- Important: Use our demo as a starting point, especially for hackathons.
- Development URL: Enter the local host URL for sandbox testing.
-
Sandbox Mode:
- Set the sandbox flag to "true" in your FE code.
- Copy the sandbox code from the Pi Mining App utilities page.
-
Deploy and Validate
- Production URL: Enter your app's live URL.
-
Validate Domain Ownership: Add the provided key to a
validation-key.txtfile at your domain's root.
-
Test a Pi Transaction
- Process a User-to-App transaction to confirm everything is connected.
Prerequisites:
- Pi KYC Completion
- Mainnet Wallet
- Create a Mainnet Developer Portal Project
- Verify Mainnet App URL (Must be unique)
- Generate a New API Key (Testnet keys won't work)
- Launch and Test!
- Mainnet Payments: A migrated wallet is required on the user's end.
- Developer Terms of Service: Ensure your app stays compliant.
- 🏠 Home - Complete developer handbook
- 🆘 Community Support - Get help from Pi developers
- 🔐 Authorization - Authentication & security patterns
- 🔌 API Reference - Complete REST API documentation
- ⚡ SDK Reference - JavaScript SDK comprehensive guide
- 📋 Data Types - Object structures & schemas
- 🌐 Pi Browser Detection - Build hybrid Web2/Web3 apps
- 🔄 Migration Guide - Upgrade to hybrid architecture
- 💻 Code Examples - Production-ready samples & templates
- 🌍 What is PiNet? - Cross-platform app accessibility
- 💳 What is PiWallet? - Pi Network wallet integration
- 💰 Payments Overview - Transaction handling guide
- 💬 Chat Rooms for Apps - Community engagement features
- 🔄 Mainnet vs. Testnet - Environment selection guide
- 📋 Developer Terms - Terms of service
- ⚖️ Social Chain ToS - Platform terms
- 📄 Whitepaper - Pi Network foundations
💡 Need help? Join our Discord community!