kinetixnetworks/rev3-api

Laravel/Composer SDK for the Rev3 NBN API platform

1.0 2026-06-23 04:46 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.0
• illuminate/support: ^10.0|^11.0|^12.0|^13.0

Requires (Dev)

• mockery/mockery: ^1.6
• orchestra/testbench: ^8.0|^9.0|^10.0|^11.0
• phpunit/phpunit: ^10.0|^11.0|^12.0|^13.0

proprietary

• Kinetix Networks

• api
• laravel
• nbn
• rev3
• kinetix

README

Welcome to the Rev3 API Laravel/Composer package documentation.

Table of Contents

1. Installation
2. Configuration
3. Quick Start
4. Partner Onboarding & Development Guide
5. 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
6. Error Handling
7. Testing
8. Changelog
9. Examples — ready-to-use snippets (front-end + Laravel backend)

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)

Onboarding & Examples

New integrators should start with the Partner Onboarding & Development Guide, which walks through the address → service qualification flow end to end (Google address autocomplete → your backend → the Rev3 client). Every code snippet in that guide is also provided as a ready-to-use file in the examples/ directory (front-end HTML/JS plus a Laravel route and controller), with its own README.

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).

Tool	Location
Claude Code	.claude/skills/rev3-api/SKILL.md
Generic / other agents	.agents/skills/rev3-api/SKILL.md

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.