Integrate Pasifika
Sign InJoin Now

API Usage

Complete API documentation for the Integrate Pasifika platform including authentication, endpoints, rate limiting, and response formats.

Secure

Multiple authentication methods with comprehensive security measures and rate limiting.

Fast

Optimized endpoints with caching and sub-3 second response times for search operations.

RESTful

Standard REST API design with consistent response formats and comprehensive documentation.

API Endpoints

Complete list of available API endpoints organized by category

Authentication

POST/api/auth/signin
User authenticationNone
POST/api/auth/signup
User registrationNone
POST/api/auth/signout
User logoutSession

Search

GET/api/search
Search across data sourcesOptional
GET/api/search/autocomplete
Search suggestionsNone
GET/api/search/external
External source searchNone

Communities

GET/api/communities
List communitiesOptional
POST/api/communities
Create communityRequired
GET/api/communities/[id]
Get community detailsOptional

Events

GET/api/events
List eventsOptional
POST/api/events
Create eventRequired
GET/api/events/[id]
Get event detailsOptional

Resources

GET/api/resources
List resourcesOptional
POST/api/resources
Upload resourceRequired
GET/api/resources/[id]
Get resource detailsOptional

Authentication Methods

Multiple authentication options for different use cases

Session-based

Traditional session-based authentication

Features

  • Secure session management
  • Automatic session renewal
  • Cross-request state persistence
  • Built-in CSRF protection

JWT Tokens

Stateless token-based authentication

Features

  • Stateless authentication
  • Scalable across services
  • Configurable expiration
  • Self-contained user data

API Keys

Simple API key authentication

Features

  • Simple implementation
  • Rate limiting support
  • Easy to manage
  • Suitable for server-to-server

Rate Limiting

API rate limits to ensure fair usage and prevent abuse

/api/search

Search API rate limiting

Rate Limit:100 requests/hour
Burst Limit:10 requests/minute

/api/communities

Community API rate limiting

Rate Limit:50 requests/hour
Burst Limit:5 requests/minute

/api/events

Event API rate limiting

Rate Limit:30 requests/hour
Burst Limit:3 requests/minute

Response Formats

Standardized JSON response formats for all API endpoints

JSON

{
  "success": true,
  "data": [],
  "message": "Success"
}

Error Response

{
  "success": false,
  "error": "Invalid request",
  "code": 400
}

Best Practices

Guidelines for effective API usage

Authentication

  • • Always use HTTPS for API calls
  • • Store API keys securely
  • • Implement proper error handling
  • • Use appropriate authentication method
  • • Rotate keys regularly

Rate Limiting

  • • Implement exponential backoff
  • • Cache responses when possible
  • • Monitor rate limit headers
  • • Handle 429 responses gracefully
  • • Use appropriate request intervals

Error Handling

  • • Check response status codes
  • • Parse error messages properly
  • • Implement retry logic
  • • Log errors for debugging
  • • Provide user-friendly messages

Data Handling

  • • Validate input data
  • • Handle pagination properly
  • • Use appropriate data formats
  • • Implement proper caching
  • • Monitor API performance