How to Integrate Using Python SDK

OverviewCopy Anchor Link

The Verizon ThingSpace API Sample App is a open-source Python web application that demonstrates how to integrate with Verizon's ThingSpace IoT platform. This sample app provides developers with a practical example of authenticating with the ThingSpace API, managing device activations, retrieving service plans, and accessing device information. Feel free to modify and extend this open-source application to suit your needs.

Target Audience: Developers building IoT applications that need to integrate with Verizon's ThingSpace platform for device management and connectivity services.

Key Use CasesCopy Anchor Link

• IoT Device Onboarding: Streamline the process of activating new devices on the Verizon network
• Service Plan Management: Query and manage connectivity service plans for your IoT devices
• Device Monitoring: Retrieve real-time device information and status updates
• API Integration Testing: Test ThingSpace API endpoints before implementing in production applications

Quick StartCopy Anchor Link

PrerequisitesCopy Anchor Link

Before running the sample app, ensure you have:

• Python 3.8 or higher installed
• Verizon ThingSpace API credentials (API key and secret)
• A Verizon ThingSpace developer account
• Git for cloning the repository

Get Running in 3 StepsCopy Anchor Link

1. Try the Live Demo: Visit the sandbox environment to explore the app's functionality immediately
2. Clone and Setup: Follow the installation steps below to run locally
3. Configure API Keys: Add your ThingSpace credentials to start making real API calls

LinksCopy Anchor Link

FeaturesCopy Anchor Link

Authentication ManagementCopy Anchor Link

• Session Token Retrieval: Secure authentication flow with ThingSpace API
• Access Token Handling: Automatic token refresh and management
• Credential Validation: Built-in validation for API keys and secrets

Device OperationsCopy Anchor Link

• Device Activation: Activate IoT devices on the Verizon network
• Device Information Retrieval: Access detailed device status, connectivity info, and metadata
• Bulk Device Management: Handle multiple devices efficiently

Service Plan ManagementCopy Anchor Link

• Plan Listing: Retrieve available service plans for your account
• Plan Details: Access pricing, data limits, and feature information
• Account Integration: Seamlessly integrate with your ThingSpace account

User InterfaceCopy Anchor Link

• Intuitive Web Interface: Clean, responsive design for easy navigation
• Real-time Updates: Live status updates for API operations
• Error Handling: Clear error messages and troubleshooting guidance

Setup & InstallationCopy Anchor Link

1. Clone the RepositoryCopy Anchor Link

git clone https://github.com/verizonlabs/thingspace-sample-app.git
cd verizon-sample-app

2. Install DependenciesCopy Anchor Link

# Create virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install required packages
pip install -r requirements.txt

3. Configure Environment VariablesCopy Anchor Link

Create a .env file in the project root:

VERIZON_API_KEY=your_api_key_here
VERIZON_API_SECRET=your_api_secret_here
VERIZON_BASE_URL=https://thingspace.verizon.com
DEBUG=False

4. Run the ApplicationCopy Anchor Link

# Start the development server
python app.py

# Access the app at http://localhost:5000

UsageCopy Anchor Link

Getting Started with the Sample AppCopy Anchor Link

1. Launch the Application: Start the local server or use the sandbox environment
2. Authenticate: Enter your ThingSpace API credentials to obtain session and access tokens
3. Explore Features: Navigate through the different sections to test API functionality

Example WorkflowsCopy Anchor Link

Activating a New DeviceCopy Anchor Link

1. Navigate to the "Device Activation" section
2. Enter device details (IMEI, ICCID, etc.)
3. Select appropriate service plan
4. Click "Activate Device" to process the request
5. Monitor activation status in real-time

Retrieving Service PlansCopy Anchor Link

1. Access the "Service Plans" section
2. Click "Load Plans" to fetch available options
3. Review plan details including data limits and pricing
4. Use plan IDs for device activation or management

Checking Device InformationCopy Anchor Link

1. Go to "Device Information" section
2. Enter device identifier (IMEI or device ID)
3. View comprehensive device details including:
   • Connection status
   • Data usage
   • Location information
   • Service plan details

CustomizationCopy Anchor Link

Extending the Sample AppCopy Anchor Link

Add New API Endpoints: The modular structure allows easy integration of additional ThingSpace API endpoints:

# Example: Add location tracking endpoint
@app.route('/device/location')
def get_device_location():
    # Implement location tracking logic
    pass

Custom UI Components: Modify the templates to match your application's branding and user experience requirements.

Database Integration: Add persistent storage for device information, usage history, or user preferences.

Configuration OptionsCopy Anchor Link

• API Timeout Settings: Adjust request timeout values in config.py
• Logging Levels: Customize logging verbosity for development or production
• UI Themes: Modify CSS files to implement custom styling

TroubleshootingCopy Anchor Link

Common IssuesCopy Anchor Link

Authentication Errors

• Problem: "Invalid API credentials" or "Authentication failed"
• Solution: Verify your API key and secret are correct and have proper permissions
• Check: Ensure your ThingSpace account has API access enabled

Connection Timeouts

• Problem: API requests timing out or failing
• Solution: Check your internet connection and ThingSpace service status
• Workaround: Increase timeout values in the configuration

Device Activation Failures

• Problem: Device activation returns error codes
• Solution: Verify device IMEI/ICCID format and ensure device is compatible with selected service plan
• Debug: Check device eligibility in ThingSpace console

Missing Dependencies

• Problem: ImportError or ModuleNotFoundError
• Solution: Run pip install -r requirements.txt to install all dependencies
• Environment: Ensure you're using the correct Python version (3.8+)

Debugging TipsCopy Anchor Link

• Enable debug mode by setting DEBUG=True in your environment variables
• Check application logs for detailed error information
• Use the sandbox environment to test API calls without affecting production data
• Verify API rate limits aren't being exceeded

SupportCopy Anchor Link

ContributingCopy Anchor Link

We welcome contributions to improve the sample app:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request with detailed description

Reporting IssuesCopy Anchor Link

If you encounter bugs or have feature requests, please open an issue on the GitHub Issues page

Version InformationCopy Anchor Link

• Current Version: v1.2.0
• Python SDK Version: verizon-sdk v2.1.0
• Last Updated: March 2024
• Compatibility: Python 3.8+, ThingSpace API v2.0

Additional ResourcesCopy Anchor Link

• Verizon ThingSpace Platform Overview
• Python SDK Documentation
• IoT Device Integration Best Practices
• API Rate Limits and Usage Guidelines