Quick start
Welcome to the Light API quick start guide! This section provides a visual walkthrough with examples of using the Light API to perform common tasks. It's designed to give you a practical understanding of how to use the API for key operations in managing electricity services.
What's covered
The quick start guide is divided into several key areas:
-
Enrollment: Learn how to search for service addresses, request available plans, and enroll customers in an electricity plan.
-
Billing: Understand how to manage payment methods, retrieve and update billing addresses, and access invoice information.
-
Location management: Explore how to handle service locations, including retrieving important documents, accessing usage data, and managing service cancellations.
Each section provides step-by-step guidance with visual examples and relevant API endpoints, giving you a clear path to implementing these features in your application.
Recommended journey
We recommend the following:
- Start with the Enrollment section to understand the basic flow of signing up a new customer.
- Move on to Billing to learn about payment and invoice management.
- Explore Location management to handle ongoing service-related tasks.
Each section includes example API requests and responses, along with explanations of key concepts. You'll also find visual representations of potential user interfaces to help you understand how these APIs can be integrated into your application.
This quick start guide is meant to give you a practical overview. For more detailed information about each API endpoint, refer to the full API Reference.
Ready to get started? Let's begin with the Enrollment process.