Getting Started

Your First API Call

Basic Authentication:

curl -X POST "https://api.mindpeeker.com/v1/auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "your_client_id",
    "client_secret": "your_client_secret",
    "grant_type": "client_credentials"
  }'

Making a Remote Viewing Request:

curl -X POST "https://api.mindpeeker.com/v1/remote-viewing/sessions" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "target_type": "location",
    "target_data": {
      "reference": "missing_person_photo.jpg",
      "coordinates": null
    },
    "viewers_required": 3,
    "priority": "high"
  }'

Platform Overview

Core Services

Remote Viewing API:

• Create and manage remote viewing sessions
• Retrieve results and analysis
• Coordinate multiple viewers
• Access historical session data

Dowsing Services:

• Map dowsing for location intelligence
• Energy signature detection
• Information dowsing for answers
• Geospatial analysis and mapping

Analytics and Insights:

• Pattern recognition and analysis
• Confidence scoring and validation
• Predictive analytics and forecasting
• Performance metrics and reporting

Integration Patterns

Real-Time Integration:

• WebSocket connections for live updates
• Real-time session monitoring
• Instant result delivery
• Interactive viewer coordination

Batch Processing:

• Asynchronous session creation
• Bulk processing capabilities
• Scheduled viewing sessions
• Batch result retrieval

Webhook Integration:

• Event-driven notifications
• Session status updates
• Result delivery notifications
• Error and alert handling

SDK Installation

Node.js SDK

Installation:

npm install @mindpeeker/sdk

Basic Usage:

const { MindPeekerClient } = require('@mindpeeker/sdk');

const client = new MindPeekerClient({
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret',
  environment: 'production'
});

async function createViewingSession() {
  try {
    const session = await client.remoteViewing.createSession({
      targetType: 'location',
      targetData: {
        reference: 'missing_person_photo.jpg'
      },
      viewersRequired: 3,
      priority: 'high'
    });
    
    console.log('Session created:', session.id);
    return session;
  } catch (error) {
    console.error('Error creating session:', error);
  }
}

Python SDK

Installation:

pip install mindpeeker-sdk

Basic Usage:

from mindpeeker import MindPeekerClient

client = MindPeekerClient(
    client_id='your_client_id',
    client_secret='your_client_secret',
    environment='production'
)

def create_viewing_session():
    try:
        session = client.remote_viewing.create_session(
            target_type='location',
            target_data={
                'reference': 'missing_person_photo.jpg'
            },
            viewers_required=3,
            priority='high'
        )
        
        print(f'Session created: {session.id}')
        return session
    except Exception as error:
        print(f'Error creating session: {error}')

Authentication and Security

OAuth 2.0 Flow

Client Credentials Flow:

const tokenResponse = await client.auth.getToken({
  grantType: 'client_credentials',
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret'
});

const accessToken = tokenResponse.access_token;

Token Management:

• Access tokens expire after 1 hour
• Refresh tokens available for long-term access
• Automatic token refresh in SDKs
• Secure token storage recommended

Security Best Practices

API Key Protection:

• Never expose API keys in client-side code
• Use environment variables for credential storage
• Implement proper key rotation policies
• Monitor API key usage and access patterns

Data Encryption:

• All API communications use TLS 1.2+
• Sensitive data should be encrypted at rest
• Implement proper data handling procedures
• Follow GDPR and privacy regulations

Rate Limits and Quotas

API Rate Limits

Standard Limits:

• 1,000 requests per hour per API key
• 100 concurrent sessions per application
• 10GB data transfer per month
• 99.9% uptime SLA guarantee

Rate Limit Headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Quota Management

Monitoring Usage:

const usage = await client.analytics.getUsage();
console.log('API calls used:', usage.apiCalls);
console.log('Sessions created:', usage.sessions);
console.log('Data transferred:', usage.dataTransfer);

Quota Increase Requests:

• Submit quota increase requests through developer dashboard
• Provide justification and expected usage patterns
• Enterprise plans available for high-volume usage
• Custom SLA options available

Error Handling

HTTP Status Codes

Success Codes:

• 200: OK - Request successful
• 201: Created - Resource created successfully
• 202: Accepted - Request accepted for processing

Client Error Codes:

• 400: Bad Request - Invalid request parameters
• 401: Unauthorized - Invalid authentication
• 403: Forbidden - Insufficient permissions
• 429: Too Many Requests - Rate limit exceeded

Server Error Codes:

• 500: Internal Server Error - Server error
• 502: Bad Gateway - Service temporarily unavailable
• 503: Service Unavailable - Maintenance in progress

Error Response Format

{
  "error": {
    "code": "INVALID_TARGET_TYPE",
    "message": "The specified target type is not supported",
    "details": {
      "supported_types": ["location", "person", "object", "information"],
      "provided_type": "invalid_type"
    },
    "request_id": "req_1234567890"
  }
}

Testing and Sandbox

Sandbox Environment

Sandbox Access:

• Full API functionality in isolated environment
• Test data and mock responses
• No charges for sandbox usage
• Separate credentials from production

Sandbox Endpoints:

const sandboxClient = new MindPeekerClient({
  clientId: 'your_sandbox_client_id',
  clientSecret: 'your_sandbox_client_secret',
  environment: 'sandbox'
});

Testing Tools

Postman Collection:

• Complete API collection for testing
• Pre-configured authentication
• Sample requests and responses
• Environment variables for easy setup

Testing Scenarios:

• Unit testing with mock responses
• Integration testing with sandbox
• Load testing for performance validation
• Error handling and edge case testing

Next Steps

Recommended Learning Path

1. Platform Overview: Understand core services and capabilities
2. Authentication: Set up secure API access
3. First Integration: Build a simple remote viewing session
4. Advanced Features: Explore analytics and webhooks
5. Best Practices: Implement security and optimization

Resources and Support

Documentation:

• Complete API reference documentation
• SDK documentation and examples
• Integration guides and tutorials
• Best practices and security guidelines

Developer Support:

• Developer community forum
• Technical support via email
• Office hours with engineering team
• Priority support for enterprise customers

Tools and Resources:

• Postman API collection
• SDK examples and templates
• Testing and debugging tools
• Performance monitoring dashboard

Ready to start building? Check out our API Reference for detailed documentation, or explore our Integration Guides for step-by-step tutorials.