Integration Prerequisites

Introduction

This guide outlines the essential prerequisites required to successfully integrate with our platform. Ensuring these requirements are met before you begin will significantly streamline the integration process and help prevent common issues.

We support various integration methods, and the specific prerequisites might vary slightly depending on your chosen approach. However, the following sections cover the general requirements applicable to most integration scenarios.

System Requirements

To host and run integration components, ensure your environment meets the following general specifications:

• Operating System: A modern, supported Linux distribution (e.g., Ubuntu LTS, CentOS Stream) or a recent version of Windows Server. macOS is suitable for development environments.
• CPU: Minimum 2 cores, recommended 4+ cores for production environments.
• RAM: Minimum 4GB, recommended 8GB+ for production environments.
• Disk Space: At least 20GB free space for application files and logs.

Network Configuration

Proper network configuration is crucial for seamless communication between your systems and our API endpoints.

• Outbound Connectivity: Your server must be able to establish outbound connections to our API endpoints on the following ports:
  • HTTPS: Port 443 (standard for secure API calls)
• Firewall Rules: Ensure your firewall allows outbound traffic to api.yourdomain.com on port 443.
• DNS Resolution: Verify that your systems can resolve our API domain names (e.g., api.yourdomain.com) to the correct IP addresses.
• IP Whitelisting: If your environment uses IP whitelisting for security, you may need to whitelist our API server IP addresses. Please refer to our API IP Address Documentation for the most up-to-date list.

Authentication Credentials

Accessing our APIs requires valid authentication credentials. You will typically need:

• API Key: A unique key generated from your developer portal account.
• API Secret: A corresponding secret key for signing requests.
• OAuth 2.0 Tokens: If using OAuth, you'll need to obtain access tokens and potentially refresh tokens.

Keep your API keys and secrets confidential and secure. Do not embed them directly in client-side code.

Authorization: ApiKey YOUR_API_KEY
                

Required Software

Depending on your integration method, you might need specific software or libraries installed:

• Programming Language Runtime: e.g., Node.js (v16+), Python (v3.7+), PHP (v8+), Java (v11+).
• HTTP Client Library: Such as `requests` (Python), `axios` (Node.js), or `curl`.
• JSON Parser: Most modern languages have built-in support.
• SSL/TLS Certificate: Ensure your system has up-to-date root certificates to establish secure connections.

API Access

Ensure that the user or service account intended to make API calls has been granted the necessary permissions within your application or system.

You can obtain API credentials and manage access from the Developer Dashboard.

Permissions

The user or service performing the integration must have appropriate permissions within your organization's account and our platform.

• Read/Write Access: Ensure the credentials used have permissions for the specific API endpoints you intend to interact with.
• Role-Based Access Control (RBAC): If your account uses RBAC, verify that the assigned roles include the necessary API permissions.

Refer to the Permissions Management Guide for detailed information.

Further Reading

• Integration Setup Guide
• API Authentication Methods
• API Endpoint Reference