Overview Copied

The CashIn Partner Platform API is a comprehensive suite of RESTful endpoints designed to integrate viral marketing and social commerce capabilities directly into your existing business infrastructure. Rather than building complex referral systems from scratch, our API transforms your platform into a intelligent social commerce engine that leverages authentic friend networks to drive growth.

What Makes CashIn Different Copied

Traditional marketing APIs focus on basic tracking and campaign management. CashIn's Partner Platform API goes beyond this by providing:

• Viral Growth Engine: Turn customers into advocates through authentic friend referrals

• Dynamic Rewards System: One campaign code delivers personalized rewards based on customer loyalty and cart value

• Privacy-First Analytics: PIIC framework ensures compliance while providing deep behavioral insights

• Fraud Protection: Advanced algorithms protect against deal aggregators and code farms

• Cross-Vendor Intelligence: Learn from anonymous network patterns without compromising privacy

API Categories Copied

The Partner Platform API is organized into six core categories, each designed to work seamlessly together:

1. Instance Management Copied

Tracks user sessions and states across your platform, connecting anonymous browsing to authenticated experiences. Instances automatically upgrade from anonymous to authenticated, maintaining continuity throughout the customer journey.

2. Authentication System Copied

Handles user signup, signin, and verification with minimal friction. Designed to feel like a natural next step rather than a barrier, supporting multiple verification methods while maintaining security.

3. Product Intelligence Copied

Transforms your inventory into campaign-ready assets through the PIIC framework. Products automatically receive intelligent summaries that optimize them for viral campaigns and social sharing.

4. Campaign Engine Copied

Creates dynamic viral marketing campaigns with intelligent rules and personalized rewards. The same campaign code can deliver different rewards based on customer profile, cart value, and loyalty tier.

5. Event Tracking Copied

Privacy-compliant user behavior tracking that connects to sessions and campaigns. Unlike traditional analytics, our trackers are designed to understand and optimize viral growth patterns.

6. Rewards & Deals Copied

Manages credits, CashFunds, and the showcase their friends deals and theirs accessible to them. Enables customers to see and share deals while intelligently ranking duplicate offers.

Authentication & API Keys Copied

Partner Authentication System Copied

CashIn uses a single, secure API key system designed for server-side integration:

Secret Keys: sk_ followed by a 32-character string

• Used for all Partner Platform API calls

• Must be kept secure on your server

• Never expose to client-side code or frontend applications

Getting Your API Keys Copied

1. Partner Onboarding: Complete the CashIn partner application process

2. Dashboard Access: Receive access to your Partner Dashboard

3. Key Generation: Generate your test and live API keys from the dashboard

4. Key Management: Rotate keys as needed for security

Critical Security Requirement: Server-Side Only Copied

All Partner Platform API calls MUST be made from your server-side code. This is not optional - it's a fundamental security requirement.

Why Server-Side Only? Copied

1. API Key Security: Secret keys must never be exposed to client-side code where they can be viewed by users

2. Data Protection: Customer data and business logic remain secure on your servers

3. Rate Limiting: Server-side calls enable proper rate limiting and abuse prevention

4. Compliance: Ensures GDPR and privacy law compliance through controlled data access

5. Fraud Prevention: Server-side validation prevents manipulation of campaigns and rewards

Implementation Architecture Copied

Your integration should follow this pattern:

Frontend Responsibilities:

• Display deals and campaigns to customers

• Collect user input (campaign codes, product selections)

• Show rewards and transaction history

• Handle user interactions

Backend Responsibilities:

• Make all CashIn API calls using secret keys

• Validate and process customer requests

• Handle campaign activation and verification

• Manage user sessions and authentication

• Process rewards and redemptions

Integration Benefits Copied

For Marketing Teams Copied

• Viral Campaigns: Create campaigns that spread organically through friend networks

• Real-time Analytics: See how campaigns perform across social media platforms

• Network Intelligence: Understand which customers drive the highest referral value

• Dynamic Rewards: Personalize offers based on customer loyalty and behavior

For Finance Teams Copied

• Accurate Tracking: Complete audit trails for all rewards and commissions

• CashFunds System: Reduce costs through CashIn-funded customer rewards

• Network ROI: Calculate true value including viral multiplier effects

• Fraud Protection: Advanced algorithms prevent abuse and ensure legitimate transactions

For Developers Copied

• RESTful Design: Standard HTTP methods and response formats

• Comprehensive Documentation: Detailed guides with working code examples

• Webhook Support: Real-time notifications for important events

• Rate Limiting: Built-in protection with clear quotas and headers

• Error Handling: Standardized error responses with debugging information

Getting Started Copied

1. Apply for Partnership: Contact CashIn to begin the partner onboarding process

2. Receive Dashboard Access: Get access to your Partner Dashboard and documentation

3. Generate API Keys: Create test keys for development

4. Review Documentation: Study the endpoint-specific integration guides

5. Build Server-Side Integration: Implement API calls in your backend systems

6. Test Thoroughly: Use test keys to validate your integration

7. Go Live: Switch to live keys and launch your viral marketing campaigns

Support and Resources Copied

• Partner Dashboard: Comprehensive analytics and key management

• Integration Documentation: Detailed guides for each API category

• Developer Support: Technical assistance during integration

• Best Practices: Proven patterns for maximizing viral growth

• Security Guidelines: Detailed security requirements and recommendations

The CashIn Partner Platform API is designed to transform your business into a viral growth engine while maintaining the highest standards of security, privacy, and user experience. By integrating our server-side API, you gain access to the power of authentic social commerce without the complexity of building these systems yourself.