Skip to main content
API Dark Pn Integrate powerful administrative capabilities directly into your applications with social.plus REST APIs. Access the same functionality available in the console programmatically, enabling automated workflows, custom integrations, and advanced community management features.
Server-Side Only: These APIs are designed for server-to-server communication and require admin-level authentication. Never expose admin credentials in client-side applications.

Authentication

Admin and user access tokens, secure mode, and API authentication

Moderation APIs

Programmatic content moderation, user management, and safety controls

Analytics APIs

Access community metrics, user data, and business intelligence programmatically

Webhook Integration

Real-time event notifications and automated response systems

​
Core API Categories

​
Administrative Functions

  • User Management: Create, update, and manage user accounts
  • Content Operations: Bulk content management and moderation actions
  • Network Configuration: Application settings and policy management
  • Reporting: Generate and export analytics data

​
Moderation Automation

  • Content Review: Automated flagging and approval workflows
  • User Actions: Programmatic bans, warnings, and restrictions
  • Policy Enforcement: Custom rules and violation handling
  • Appeal Processing: Automated appeal workflows and notifications

​
Analytics & Insights

  • Usage Metrics: Access MAU, DAU, and engagement statistics
  • Content Analytics: Performance data for posts, comments, and media
  • Moderation Reports: Safety metrics and policy effectiveness data
  • Custom Reporting: Generate tailored reports for business needs

​
Real-Time Events

  • Webhook Integration: Receive real-time notifications for platform events
  • Pre-Hook Events: Intercept and modify events before processing
  • Custom Workflows: Build automated response systems and integrations

​
Getting Started

1

Obtain Admin Access Token

Generate an admin access token from your console under Settings → Admin Users
2

Choose Authentication Method

Select between admin tokens for server operations or user tokens for user-context actions
3

Configure API Client

Set up your server environment with proper authentication and regional endpoints
4

Test Integration

Start with simple API calls to verify connectivity and permissions

​
Authentication Methods

  • Admin Access
  • User Access
  • Secure Mode

​
Admin API Access Token

For server-to-server API calls with full administrative privileges:
1

Generate Token

Navigate to Console → Settings → Security → Admin API Access Token
2

Configure Permissions

Set appropriate scopes and expiration for your integration
3

Secure Storage

Store the token securely and rotate regularly
Admin tokens provide full access to your application. Never expose them in client-side code or public repositories.
curl -X 'GET' \
  'https://apix.<region>.amity.co/api/v3/users' \
  -H 'accept: application/json' \
  -H 'x-admin-token: <your-admin-token>'

​
Token Management

  • Secure Storage: Use environment variables or secure key management systems
  • Regular Rotation: Implement automated token rotation procedures
  • Scope Limitation: Use minimum required permissions for each token
  • Monitoring: Log and monitor API usage patterns and anomalies
  • Revocation: Implement emergency token revocation procedures
  • HTTPS Only: Always use HTTPS for API communications
  • IP Whitelisting: Implement IP restrictions where possible
Validate Tokens
const validateToken = async (token) => {
  try {
    const response = await fetch('https://apix.region.amity.co/api/v3/users/me', {
      headers: { 'Authorization': `Bearer ${token}` }
    });
    return response.ok;
  } catch (error) {
    return false;
  }
};
Revoke User Access Tokens Admin tokens can revoke user access tokens using the Revoke API:
curl -X DELETE "https://apix.region.amity.co/api/v4/sessions" \
  -H "x-admin-token: YOUR_ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId": "user123"}'
Rate Limiting
  • Respect API rate limits to avoid throttling
  • Implement exponential backoff for retry logic
  • Use batch operations when available for efficiency
  • Cache responses appropriately to reduce API calls
Error Handling
  • Implement comprehensive error handling for all API calls
  • Log errors with sufficient detail for debugging
  • Provide graceful degradation when APIs are unavailable
  • Monitor API response times and success rates

​
Common Use Cases

Content Monitoring
  • Set up automated scanning for new content
  • Apply custom moderation rules based on community guidelines
  • Integrate with external moderation services
  • Handle bulk content operations efficiently
User Behavior Management
  • Automatically flag suspicious user patterns
  • Implement graduated response systems
  • Handle coordinated abuse or spam campaigns
  • Maintain audit trails for compliance
Custom Analytics
  • Export data to business intelligence tools
  • Create custom reports for stakeholders
  • Track KPIs specific to your business model
  • Integrate with existing analytics platforms
Growth Analysis
  • Monitor user acquisition and retention
  • Track feature adoption and usage patterns
  • Analyze community health indicators
  • Generate executive dashboards
User Lifecycle Management
  • Automate user onboarding processes
  • Handle account verification and upgrades
  • Manage subscription and billing integrations
  • Implement custom user journey flows
Content Operations
  • Bulk import/export of content
  • Automated content promotion and featuring
  • Cross-platform content synchronization
  • Content archival and cleanup processes
Webhook Automation
  • Receive real-time notifications for platform events
  • Trigger automated workflows based on user actions
  • Integrate with external systems and services
  • Build custom notification and alert systems
Event Processing
  • Process content creation, modification, and deletion events
  • Handle user registration, login, and activity events
  • Implement custom business logic with pre-hook events
  • Create audit trails and compliance reporting

​
Regional Endpoints

Different regions have specific API endpoints for optimal performance:
RegionAPI Endpoint
US Easthttps://apix.us.amity.co
Europehttps://apix.eu.amity.co
Singaporehttps://apix.sg.amity.co
Performance Optimization: Always use the regional endpoint closest to your server infrastructure for best performance and lowest latency.

​
Next Steps

API Reference

Complete API documentation with endpoints and examples

Webhook Setup

Configure real-time event notifications and automated responses

Pre-Hook Events

Intercept and modify events before they’re processed

User Activity Reports

Generate comprehensive user activity and engagement reports

Network Settings

Configure platform-wide settings and policies

Activity Reports

Generate comprehensive user activity and engagement reports
Production Considerations: Test all API integrations thoroughly in a development environment before deploying to production. Monitor API usage and implement proper error handling and logging.
Need help implementing a specific API integration? Check our developer community or contact support for guidance.