🚀 Getting Started
Last updated

Getting Started

We're glad to have you on board! Our team is committed to making your integration journey as smooth as possible. For any support or questions, please email us at integrations@fl3xx.com.

Step 0: Understanding FL3XX Policies, Standards, and API Documentation

Before beginning your integration, it is essential to review FL3XX’ policies, standards, and API documentation to ensure compliance and a seamless development process.

FL3XX Policies and Standards

Familiarize yourself with the following key documents:

API Documentation
Legal Agreements (Required for Partners & Service Providers)

Step 1: Planning & Partnership Agreements

To ensure a smooth and effective integration process, follow these steps:

  1. Define Your Integration Goals

  2. Contact integrations@fl3xx.com to outline your objectives, required API endpoints, and data needs.

If you are a Partner or Service Provider, please also follow these additional steps: 3. Sign Legal Agreements – FL3XX will send the Non-Disclosure Agreement (NDA) and Partner Program Agreement (PPA) via DocuSign for signature.

  1. Formalize the Partnership – Complete the NDA and PPA to proceed with the integration.

Step 2: Obtaining a Security Token for Testing

Once Step 1 is complete (and agreements are signed for partners and service providers), FL3XX will give you API credentials for the Test Environment, so you can start development in a secure test environment.

Step 3: Development & Testing

With Test Environment access, start building and testing your integration. Utilize FL3XX’ documentation and support resources to ensure efficient development.

Note: FL3XX provides up to two hours of free implementation support via email or video conference upon request. Additional support may be available at FL3XX’ discretion and is typically billed based on man-hours.

Step 4: Demo Call with FL3XX

Once your development is complete, schedule a demo call with FL3XX. To do so, contact integrations@fl3xx.com This session allows you to:

  1. Present your integration progress
  2. Demo your product and integration
  3. Address any technical questions
  4. Discuss the FL3XX Integration Ecosystem & potential marketing opportunities

Step 5: Issuing a Token for Pre-Production Testing in Stage

The Stage Environment is a pre-production environment designed for final testing before going live. It provides access to real operator data but is not connected to the production environment in real-time. Any changes made in staging will not affect the live production system.

Find an operator

In order to proceed to this step you need to find an operator (live user of FL3XX) who is willing to become a Beta tester for your integration.

How the Stage Environment Works
  • Stage is a snapshot of the Production Environment, updated every Saturday at 12:00 UTC.
  • Quotes, flights, settings, and IDs are real as of the last sync.
  • Names and surnames are anonymized in compliance with GDPR policies, but IDs remain unchanged.
Credential Resets & Access
  • Every Saturday, staging credentials and tokens are reset.
  • To regain access, you need to request new credentials on Monday morning or on demand by contacting integrations@fl3xx.com.
Usage & Time Limit
  • Stage should be used only for final testing and adjustments before moving to production.
  • Testing should not exceed two weeks to maintain efficiency and system integrity.
Operator's Approval Process
  • To issue the Stage token, FL3XX requires the operator's confirmation before issuing any Stage credentials.
  • Upon the operator's request, FL3XX will issue Stage API credentials to allow testing in a production-like environment.

Note: This confirmation is needed only once per operator.

Step 6: Access Token for the Production Environment

Once your integration has been successfully tested in the Stage Environment and approved by the operator, the operator can request production credentials. FL3XX will then provide API access to the Production Environment, making your integration fully operational.

For New Operators Using Your Integration

  • Any new operator who wishes to use your integration does not need to repeat the full integration process described in Steps 1-5.
  • They can proceed directly to Step 6 and request a production API token for immediate access.

Important Considerations – Industry Standard Compliance

Before accessing the live FL3XX environment, ensure your application adheres to industry security, compliance, and best practices:

  • Securely handle authentication tokens to prevent unauthorized access.
  • Ensure the X-Auth-Token is hardcoded and not user-configurable.
  • Do not interact with live API servers during development or testing.
  • Prevent unauthorized sharing or exposure of API-returned data.
  • Ensure compliance with GDPR, CCPA, and other data privacy regulations.
  • Implement audit logging for API access tracking and anomaly detection.
  • Ensure the application can process new API properties introduced after the initial implementation.
  • Do not modify, or manipulate API-generated IDs.
  • Adhere to API rate limits and follow the call frequencies described in this developer portal to avoid disruptions.
  • Implement exponential backoff retry policies for failed API calls.
  • Regularly review API version updates and adjust your integration accordingly.
  • Follow secure development practices and conduct regular security reviews.
  • Avoid bulk calls, as FL3XX reserves the right to revoke the token if excessive calls disrupt platform functionality. If bulk calls are necessary, contact integrations@fl3xx.com for a review.
 
Next page