API Integration Process

This guide outlines the process for integrating with Amili's API. The API reference provides detailed endpoint specifications and examples to make implementation as straightforward as possible for our customers and partners.

Getting Started

Amili will provide the initial setup of your partner/customer account, including API credentials and authentication details (see Authentication).

What You Need to Prepare

Before starting the integration project, please have ready:

• Technical Contact Person: Your main contact for coordinating the integration project with Amili
• Development Resources: Team members needed for planning, analysis, and implementation
• Required Use Cases: Clear description of what you want to achieve with the integration
• Integration Entry Point: Identify whether you're starting with invoice processing, reminders, or debt collection

Step 1: Account Setup and Authentication

We will configure your account and ensure secure API access is properly established.

Your Responsibilities

• Verify Access: Test your account credentials and confirm you can access the sandbox environment
• Review Documentation: Familiarize yourself with the API reference and authentication requirements

What Amili Provides

• Account Configuration: Set up your partner/customer account in our system
• API Credentials: Provide your API user credentials and public key
• Authentication Setup: Configure and verify your API authentication is working correctly
• Sandbox Access: Grant access to our testing environment

Step 2: Development and Implementation

This is where your development team builds the integration using our API. We will provide ongoing support throughout the development process.

Your Responsibilities

• API Development: Implement API calls according to our API specifications
• Data Exchange Testing: Test sending and receiving data through our API
• Test Data Preparation: Create test data that represents your real-world scenarios

What Amili Provides

• Technical Support: Direct access to our Integration team for questions and guidance
• API Documentation: Comprehensive documentation with examples and use cases
• Sandbox Environment: Full access to our testing environment with realistic data
• Code Review Support: We can review your implementation approach and provide feedback
• Integration Examples: Reference implementations and code samples when available

Step 3: Testing and Verification

Once your implementation is complete, we will work together to thoroughly test the integration and ensure it's ready for production use.

Your Responsibilities

• Comprehensive Testing: Execute all planned test scenarios using your test data
• Data Validation: Verify that data is being sent and received accurately
• Error Handling: Test how your system handles various error conditions and edge cases
• Issue Reporting: Document and report any problems or unexpected behavior
• Performance Testing: Ensure your integration performs well under expected load
• User Acceptance Testing: Have your end users test the integration in realistic scenarios

What Amili Provides

• Data Verification: We will verify that data received in our systems is correct and complete
• Issue Resolution: Direct support for resolving any technical issues that arise
• Error Analysis: Help analyze and debug any problems with API responses or data processing

Step 4: Production Launch and Go-Live

When both parties are confident the integration is ready, we will activate it in the production environment with careful monitoring.

Your Responsibilities

• Production Readiness: Confirm your system is ready for live data processing
• Monitoring Setup: Configure your monitoring and alerting systems for the integration
• Go-Live Coordination: Work with us to schedule the production activation
• Initial Monitoring: Closely monitor the first few days of production usage
• Issue Escalation: Have a clear process for reporting any production issues

What Amili Provides

• Production Environment: Activate your integration in our live production environment
• API Monitoring: Continuous monitoring of API performance and availability
• Support Team Access: Provide contact information for ongoing technical support
• Issue Response: Rapid response to any production issues or concerns