illu Help Desk
Web App
illu Help Desk
illu Help Desk
  • 👋Welcome to illu
  • 🚀Quick Start Guide
    • Workflow Provider Org
    • Full Access Installer Org
    • Guest Installer Org
  • 📚Workflow Library
    • đŸ“ĻWorkflow Packs
    • 🏠Residential Solar & Storage Best Practices
    • â˜€ī¸C&I Solar Inspection & Testing (IEC 62446-1)
    • 🔋C&I ESS Visual Inspection and Monitoring
    • 🔌Hardware Specific
      • 🟩SimpliPhi
      • 🟧Enphase
      • 🟩Schneider Electric
      • đŸŸĢOutback Power
    • 📃Frontline Safety and Reporting
    • đŸ“ĨRequest a Workflow
  • đŸ™‹â€â™€ī¸Get Help
  • Fundamentals
    • 👩‍đŸĢillu Basics
    • 👩‍đŸ’ģSubscription Tiers and Features
    • đŸ’ģWhat Devices Support illu?
    • đŸŽī¸New and Upcoming Features
    • 📴Offline Mode
  • Accounts and Members
    • 🤝Create an Account and new Organization
    • 📨Inviting Team Members
    • 👍Accepting an Invitation
    • đŸ’ŧFor Admins
      • â„šī¸Setting Custom Job Fields
      • 👩‍đŸ’ģManaging Admins & User Access
      • đŸ’ĩManaging Billing and Payment
    • 🧑Changing & Managing Accounts
      • 🔒Change Password
      • 📲Transfer an Account
      • đŸšŊDelete an Account
  • Workflows
    • đŸ—ēī¸Workflow Overview
    • ➕Create a Workflow
    • đŸ—ƒī¸Organizing Workflows with Folders & Tags
    • 📤Publish & Share Workflows
    • 📋Add Workflows to a Job
    • 💡Workflow Tips & Tricks
  • Jobs
    • 🤹Job Basics
      • ➕Create & Delegate Job
      • âœī¸Edit Job Requirements
      • ✨Update Job Progress
    • 📱Completing Jobs and Workflows on Mobile App
      • From a Shared URL/QR Code
      • From Your Workflow List
    • đŸ—ēī¸View Jobs on Map
    • 📄Generate Job Report
    • âŦ‡ī¸Bulk Export Job Data
  • SITES
    • 🧭Create/Edit Job Sites
    • âš™ī¸Site Equipment Register
  • illu API
    • 🔑API Overview
    • 🔌API Examples
      • âš ī¸Trigger New Job on Alert
      • 📍Create New Site on Project Start
      • ✅Update Job Status on Approval
  • Best practices
    • 🔧Maintenance
      • 💸Why it matters
      • đŸĻēSafety first!
      • đŸ—“ī¸Planned
      • 🚨Reactive
    • â˜€ī¸Technology-specific
      • 🔋Battery storage
      • 🔌Distribution
      • 🔀Inverters
      • â˜€ī¸Solar PV
    • 💡Examples
      • IEC 62446-1 Summarized
      • â˜€ī¸Community Solar Mini-grid
      • â˜€ī¸Solar C&I
  • 💡Tips
    • 🔁How to Set Up Recurring Proccesses
    • đŸŽŦExample of illu in Action
  • Support
    • ❓Frequently Asked Questions
    • 🤒Known Issues
  • Links
    • đŸ–ąī¸Demo
    • 🤝Terms of Service
    • 🔏Privacy Policy
    • 📧Contact Us
  • đŸ’ĒUse Cases
    • đŸ› ī¸illu for OEMs
    • đŸ‘ˇâ€â™€ī¸illu for Installers
Powered by GitBook
On this page
  • API Key and Authentication
  • API Specifications
  • Use Case Examples

Was this helpful?

  1. illu API

API Overview

Our open API lets you create seamless integrations with the illu platform

PreviousSite Equipment RegisterNextAPI Examples

Last updated 1 year ago

Was this helpful?

The illu API enable your team to , minimizing data loss, mistakes, and time to make manual data transfers. With the API you can, for example:

  • Trigger illu jobs when an alert is triggered

  • Create and update sites on illu when a new project is greenlit

  • Trigger invites to new users to join your organization

  • Update job status in illu when work is approved

If you need help implementing the APIs, please reach out to the illu support team at support@illu.works.

API Key and Authentication

The illu API uses API keys to authenticate requests. Only admin users can generate and view an API key and only on the web application. To view your API key

  1. Navigate to the API Key tab

Whenever your password is changed or API key is regenerated, any integrations using the previous API key will be invalidated.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Use your API key in your request header in the format below.

Authorization: Bearer {{your_api_key}}

API Specifications

Please see the API documentation of the latest version below:

Use Case Examples

Open the Admin Console. To access the Admin Console, click your Account Icon in the top right corner of the screen to open a drop down menu. Click the to open it.

Press Show Key and enter your password to reveal the key

You can regenerate an API key by pressing the refresh icon

All API requests must be made over . Calls made over plain HTTP will fail. API requests without authentication will also fail.

🔑
HTTPS
âš ī¸Trigger New Job on Alert
📍Create New Site on Project Start
✅Update Job Status on Approval
FastAPI - ReDoc
Logo