Adding Custom Integrations (API Key)
For services that don’t support OAuth or when you need more control over authentication, you can add custom integrations using API keys.When to Use Custom Integrations
Custom integrations are ideal for:- Legacy systems without OAuth support
- Internal APIs requiring specific authentication
- Services with API key authentication
- Custom webhook endpoints
Supported Authentication Methods
ChatATP supports various authentication methods:- API Key: Simple token-based authentication
- Bearer Token: JWT or similar token authentication
- Basic Auth: Username/password authentication
- Custom Headers: Any custom authentication headers
Adding a Custom Integration
Step 1: Gather API Credentials
Collect the necessary authentication information:- API endpoint URL
- Authentication method
- Credentials (API key, token, username/password)
- Required headers or parameters
Step 2: Configure in ChatATP
- Navigate to Accounts > Tap on Integrations Tab in the Custom Integrations / Services (API Keys) section
- Click “Add Custom Integration”
- Provide a descriptive name and unique-name for the integration that match a toolkit requirements
- Click “Save”
Step 3: Set Authentication
Choose your authentication method and enter the credentials:- For API Key: Select header or query parameter method
- For Bearer Token: Enter the token value
- For Basic Auth: Provide username and password
Step 4: Test the Integration
- Click “Test Connection” to verify the setup
- ChatATP will make a test request to ensure connectivity
- Check the response to confirm everything is working
Managing Custom Integrations
Available Operations
Once configured, you can:- View integration status in the dashboard
- Update credentials when tokens expire
- Test connectivity to ensure uptime
- Delete integrations no longer needed
Security Considerations
- Store API keys securely in ChatATP’s encrypted storage
- Use read-only keys when possible
- Regularly rotate API keys
- Monitor API usage for anomalies
Troubleshooting Custom Integrations
Common issues and solutions:- Authentication failed: Verify credentials are correct and active
- Connection timeout: Check network connectivity and API availability
- Invalid response: Ensure the API endpoint is correct
- Rate limiting: Implement proper rate limiting in your agent logic