API Access

What is LuxSci's API?

LuxSci’s application programming interface (API) enables the integration of LuxSci with third-party applications.

LuxSci API access is available upon request for no additional charge — ask our support staff to enable your account for access if you are interested.

LuxSci’s API is REST-based and uses JSON for data transport. The following pages contain the complete documentation for the API, along with code samples that can be used for writing API client programs in various languages.

API Usage

API Mechanics Guide

1. API Integrations
   1. Create an API Integration
   2. Edit Your API Integration
   3. Retrieve your API Integration Keys
   4. API Integration Properties
   5. Protect your API Integration
   6. API Access Controls
2. User and Account Scope
3. API Requests and Responses
4. Authentication & Calling the API​
   1. OAuth 2
   2. API Key
   3. Basic Auth
   4. LuxSci Secure
5. Requests with File Upload
6. Response Codes

API Reference

API Endpoint Index

• API Change List
• API YAML Document
• API Reports:
  • API Reporting Basics
  • API Report Responses
• Sending Email:
  • Sending Email via the API
  • SMTP 3-Digit Status Codes
• WebAides Definitions

Software Development Kits (SDKs)

• Current SDK version: v2025.0.3 released January 18th, 2025

These SDKs work for API Integrations configured to use the “LuxSci Secure” authentication mechanisms.  SDK help can be found in the readme file inside the SDK archive. Click on the language below to download its SDK.

Sample Code

Here is an example of client-side code for calling LuxSci API endpoints for APIs configured with the “LuxSci Secure” authentication mechanisms. These simple examples can be used as a basis for building your API client programs.

We recommend using the provided SDKs for the fastest time-to-success vs building your API client that supports “LuxSci Secure” authentication.

Click on a language to download: