jon/LocaleLogic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
66 commits 1 branch 0 tags 606 KiB
  • PHP 68.4%
  • Blade 29.4%
  • Shell 1.6%
  • Dockerfile 0.4%
  • CSS 0.1%
  • Other 0.1%
Find a file
Exact
Jon Hubbard a607c7c5cf chore: Rotate Flux UI Pro license key 
Old key was exposed in public git history (commit dd05232).
Replaced with new per-product key.
2026-02-08 16:12:10 +00:00
agent-os Build complete Laravel Livewire application with FluxUI v2 2025-12-24 01:14:51 +01:00
app fix(spatial): Use correct boundary_type names (wards, parishes) 2026-01-18 23:15:55 +01:00
bootstrap Add ONS boundary monitoring system with outdated file detection and manual check tracking 2025-12-27 22:58:16 +01:00
config Add comprehensive ONSUD import progress tracking with real-time UI 2025-12-24 20:49:22 +01:00
database feat(spatial): Add PostGIS point-in-polygon for accurate postcode-to-boundary mapping 2026-01-18 22:42:51 +01:00
deploy-scripts chore: Rotate Flux UI Pro license key 2026-02-08 16:12:10 +00:00
docs Add comprehensive documentation for council API endpoints 2025-12-27 01:36:43 +01:00
public Remove compiled views and build artifacts from version control 2025-12-27 11:53:25 +01:00
resources Add ONS boundary monitoring system with outdated file detection and manual check tracking 2025-12-27 22:58:16 +01:00
routes feat(spatial): Add PostGIS point-in-polygon for accurate postcode-to-boundary mapping 2026-01-18 22:42:51 +01:00
storage/app/onsud Add ONS boundary monitoring system with outdated file detection and manual check tracking 2025-12-27 22:58:16 +01:00
tests Add ONS boundary monitoring system with outdated file detection and manual check tracking 2025-12-27 22:58:16 +01:00
.gitignore fix(security): Remove exposed auth.json and re-add to .gitignore 2026-02-06 04:01:46 +00:00
artisan Build complete Laravel Livewire application with FluxUI v2 2025-12-24 01:14:51 +01:00
CLAUDE.md Add ONS boundary monitoring system with outdated file detection and manual check tracking 2025-12-27 22:58:16 +01:00
composer.json feat(spatial): Add PostGIS point-in-polygon for accurate postcode-to-boundary mapping 2026-01-18 22:42:51 +01:00
composer.lock feat(spatial): Add PostGIS point-in-polygon for accurate postcode-to-boundary mapping 2026-01-18 22:42:51 +01:00
Dockerfile chore: Rotate Flux UI Pro license key 2026-02-08 16:12:10 +00:00
LOOKUP_IMPORT_FIX_SUMMARY.md Add lookup import fix documentation 2025-12-25 12:56:01 +01:00
MONITORING_SETUP.md Update .gitignore and add missing files 2025-12-24 20:53:28 +01:00
package-lock.json Add comprehensive ONSUD import progress tracking with real-time UI 2025-12-24 20:49:22 +01:00
package.json Add comprehensive ONSUD import progress tracking with real-time UI 2025-12-24 20:49:22 +01:00
phpunit.xml Add comprehensive ONSUD import progress tracking with real-time UI 2025-12-24 20:49:22 +01:00
tailwind.config.js Add comprehensive ONSUD import progress tracking with real-time UI 2025-12-24 20:49:22 +01:00
vite.config.js Add comprehensive ONSUD import progress tracking with real-time UI 2025-12-24 20:49:22 +01:00

docs/README.md

LocaleLogic API Documentation

Welcome to the LocaleLogic API documentation. This directory contains comprehensive guides for integrating with our APIs.

Available Documentation

📘 API Documentation

Complete reference for the Postcode Lookup API including:

  • Authentication details
  • Endpoint specifications
  • Response formats
  • Error handling
  • Examples and use cases
  • Technical implementation notes

Best for: First-time integration, comprehensive reference, troubleshooting

⚡ Quick Reference Guide

Condensed cheat sheet with:

  • Common request patterns
  • Response structure
  • Error codes table
  • Quick copy-paste examples

Best for: Daily development, quick lookups, experienced users

🔧 OpenAPI Specification

Machine-readable API specification in OpenAPI 3.0 format:

  • Import into Swagger UI for interactive documentation
  • Generate client SDKs automatically
  • Integrate with API testing tools
  • Validate requests and responses

Best for: API tooling integration, SDK generation, automated testing

📮 Postman Collection

Ready-to-use Postman collection with:

  • Pre-configured requests for all endpoints
  • Error scenario examples
  • Environment variables setup
  • Request descriptions and examples

Best for: Manual testing, team sharing, API exploration

To use: Import into Postman → Set api_token variable → Start testing

Getting Started

  1. Obtain an API Token

    php artisan api:create-token your@email.com

  2. Make Your First Request

    curl "https://dev.localelogic.uk/api/v1/postcodes/SW1A1AA" \
  -H "Authorization: Bearer YOUR_TOKEN"

  3. Explore the Response

    • Geography hierarchy (ward → region)
    • Coordinates (WGS84 & OS Grid)
    • Property count
    • Optional UPRNs

API Versions

  • v1 (Current): Postcode Lookup API - Full geography data with optional UPRNs

Support

Additional Resources

Internal Documentation

External Resources