Partner API Overview

The Iagon Insight Partner API allows you to programmatically manage API credentials and user accounts for your integration. This enables you to:

• Create user accounts for your customers
• Generate API credentials linked to those users
• Track usage per user for billing purposes
• Monitor all administrative actions via audit logs

Base URL

https://api.iagon.io/v1/admin

Workflow

1. Initial Setup
   ├── Receive your admin key from Iagon (iiak_admin_xxxxx)
   └── Store it securely

2. User Management
   ├── Create user accounts for your customers
   ├── Use external_id to link to your own customer IDs
   └── Track billing plans

3. Credential Management
   ├── Create API credentials for users
   ├── Each credential can be linked to a user account
   └── Configure rate limits and expiration

4. Monitoring
   ├── Query usage statistics per user/credential
   ├── Review audit logs
   └── Generate billing reports

Key Concepts

Admin Keys

Admin keys (iiak_admin_*) are used to authenticate with the Partner API. Each admin key:

• Belongs to a specific entity (your organization)
• Has granular permissions (manage credentials, manage users, view logs, etc.)
• Can only access resources it created

User Accounts

User accounts represent your customers. Each user account:

• Is scoped to your admin key (you can only see your users)
• Has an optional external_id for linking to your own system
• Can have multiple API credentials
• Tracks billing plan and status

API Credentials

API credentials (iiak_*) are the keys your users use to call the Iagon Insight API. Each credential:

• Can optionally be linked to a user account
• Has configurable rate limits and expiration
• Usage is tracked for billing

Permissions

Your admin key has specific permissions that control what operations you can perform:

Permission	Description
manage_credentials	Create, view, and revoke API credentials
manage_users	Create and manage user accounts
view_audit_logs	View audit log entries
view_usage	View usage statistics

Next Steps

1. Set up authentication
2. Create your first user account
3. Generate API credentials