README

Welcome to the Rev3 API Laravel/Composer package documentation.

Table of Contents

1. Installation
2. Configuration
3. Quick Start
4. API Reference
   • Address
   • Appointments
   • Callbacks
   • Diagnostics
   • Fibre Uplift
   • Network Performance
   • Orders
   • Orders Delayed
   • Outage
   • Party
   • Product Inventory
   • Product Qualification
   • Provisioning
   • Quotes
   • Resource Planning
   • Service Health
   • Service Qualification
5. Error Handling
6. Testing
7. Changelog

Overview

The Rev3 API package provides a clean, type-safe PHP SDK for interacting with the Rev3 NBN API platform. It supports both Laravel applications (via Service Provider and Facade) and standalone PHP projects.

Features

• Complete API Coverage: All 95 endpoints across 17 endpoint groups
• Laravel Integration: Auto-discovery Service Provider and Facade
• Type Safety: Full type hints on all methods
• Error Handling: Dedicated exception classes for different error types
• Testing Support: Mock-friendly design for easy unit testing
• AI Agent Skills: Ready-to-use skills for AI coding assistants (see below)

AI Agent Skills

To help your developers integrate faster, this package ships with ready-made skills/rules for AI coding assistants. If your team uses one of these tools, the skill is picked up automatically from the package and gives the assistant accurate, up-to-date guidance on using the Rev3 client (setup, qualification flows, responses, error handling, and conventions).

No setup is required — these are reference materials for your AI tooling and have no effect on the runtime behaviour of the library.

Licence

This software is provided to partners under a commercial licence from Kinetix Networks Pty Ltd. See LICENSE for the full terms. Use of the Software is also subject to your agreement governing access to the Rev3 Platform.