Enterprise Integration Guide

Machine-to-Machine (M2M) Integration Developer Guide

Overview

This documentation provides detailed instructions for integrating with Amigo's backend APIs for machine-to-machine (M2M) use cases. It covers authentication, user management, service discovery, and conversation management.

Authentication Requirements

All Amigo backend APIs require proper authentication:

  • Authentication Token: Every API request must include a valid token corresponding to an Amigo user

  • Service Account: For M2M integration, use a dedicated service account to generate and manage organization-level API keys

  • Authorization Flow: Organization-level API keys are used to create user sessions (bearer tokens with expiration time)

  • Request Headers: Bearer tokens must be included in the Authorization header to authenticate requests

Key Security Considerations

  • API keys are valid for a maximum of 90 days

  • Implement automatic key rotation using the API key creation endpoint

  • Store credentials securely following security best practices

  • Map Amigo users to your internal user management system for consistent tracking

Last updated

Was this helpful?