Engagifii Events API Documentation

Overview

The Engagifii Events API is a comprehensive microservice for managing events, registrations, exhibitor booths, and related activities. This RESTful API powers event management functionality with support for member registration, exhibitor management, booth configuration, bundle management, and approval workflows.

Quick Start (5-Minute Integration)

Prerequisites

• API access credentials (Client ID and Client Secret)
• Tenant code for your organization
• Base API URL

Base URLs

Environment	URL
Production	https://engagifii-prod-event.azurewebsites.net
Staging	Contact support for staging URL
Development	Contact support for development URL

Your First API Call

# 1. Get access token (using IdentityServer)
curl -X POST "{IDENTITY_SERVER_URL}/connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "client_id={YOUR_CLIENT_ID}" \
  -d "client_secret={YOUR_CLIENT_SECRET}" \
  -d "grant_type=client_credentials" \
  -d "scope=EventsApi"

# 2. List events
curl -X POST "https://engagifii-prod-event.azurewebsites.net/api/1.0/event/list" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "api-version: 1.0" \
  -H "tenant-code: {YOUR_TENANT_CODE}" \
  -H "Content-Type: application/json" \
  -d '{"PageNumber": 1, "PageSize": 10}'

API Version

Current API version: 1.0

Version must be specified in the api-version header for all requests.

Key Features

• Event Management: Create, update, and manage events with complex scheduling
• Registration System: Handle member and exhibitor registrations with approval workflows
• Booth Configuration: Manage exhibitor booth assignments and configurations
• Bundle Management: Create and manage event bundles with visibility controls
• Multi-tenancy: Full tenant isolation with tenant-code header
• Approval Workflows: Configurable multi-step approval processes
• Real-time Updates: Event-driven architecture with service bus integration
• Comprehensive Filtering: Advanced search and filter capabilities across all entities

API Categories

Core Endpoints

• Events: Event CRUD operations and management
• Registrations: Member and exhibitor registration handling
• Booths: Booth configuration and assignment
• Bundles: Event bundle management
• Activities: Session and activity management

Supporting Endpoints

• Organizations: Organization management
• Venues: Venue and room configuration
• Speakers: Speaker management
• Invoices: Financial and invoice handling
• Settings: Configuration and preference management

Authentication

The API uses OAuth 2.0 Bearer Token authentication via IdentityServer4.

Required Headers

Every API request must include:

• Authorization: Bearer {access_token}
• api-version: 1.0
• tenant-code: {your_tenant_code}

See authentication.md for detailed authentication setup.

Response Format

All API responses follow a consistent JSON structure:

Success Response

{
  "data": {
    // Response data
  },
  "totalCount": 100,
  "pageNumber": 1,
  "pageSize": 10
}

Error Response

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {
      // Additional error details
    }
  }
}

Rate Limiting

The API implements rate limiting to ensure fair usage:

• Default limit: 1000 requests per minute per tenant
• Burst limit: 100 concurrent requests
• Rate limit headers are included in responses

Pagination

List endpoints support pagination via:

• PageNumber: Page number (starting from 1)
• PageSize: Items per page (default: 10, max: 100)

Support & Resources

Documentation

• Getting Started Guide
• Authentication Setup
• API Reference
• Data Models
• Error Handling
• Quick Reference

Integration Examples

• JavaScript/Node.js
• Python
• C#/.NET

Support Channels

• Technical Support: support@engagifii.com
• API Status: status.engagifii.com
• Developer Portal: developers.engagifii.com

Changelog

See CHANGELOG.md for version history and updates.

License & Terms

Use of this API is subject to the Engagifii API Terms of Service. Contact your account manager for licensing information.