echallan/api

PHP SDK for the eChallan platform (root-level composer.json to satisfy Packagist).

dev-main 2025-11-27 14:46 UTC

Requires

• php: >=8.1
• guzzlehttp/guzzle: ^7.0

Apache-2.0

• eChallan Team

README

Comprehensive Vehicle & Challan Management System

Access vehicle information, challan data, and government records through our powerful API. Choose your access level below to get started.

GitHub: https://github.com/vahanfin/eChallan-Api.git

Copyright 2025 Vahanfin Solutions Private Limited

License: This project is licensed under the Apache License, Version 2.0. See the LICENSE file for the full license text and the NOTICE file for additional usage and trademark notices.

Layout

• python/ – PyPI-ready package using pyproject.toml and requests.
• nodejs/ – npm-ready module with a npm run build pack step.
• php/ – Composer library with PSR-4 autoloading and Guzzle client.
• java/ – Maven Java 17 SDK with mvn package.
• kotlin/ – Gradle Kotlin/JVM SDK using OkHttp.
• go/ – Go module skeleton with a simple HTTP client.
• dotnet/ – .NET 8 class library ready for dotnet pack.
• swift/ – Swift Package targeting iOS/macOS with async/await client.
• curl/ – cURL one-liners for quick manual calls.
• yaml/ – shared configuration sample for tooling and deployment.
• json/ – reusable request/response samples.
• other/ – notes for extending to Java, .NET, Go, or more.
• endpoints.json – generated map (88 endpoints) from the Postman collection for SDK dynamic calls.
• examples/ – quick scripts to list/validate endpoints via Python and Node.js SDKs.

Each SDK includes a callEndpoint-style helper plus a listEndpoints/list_endpoints function to enumerate all available routes (ids, methods, paths) sourced from endpoints.json.

Each SDK exposes simple health, challan submission, and challan fetch helpers. Point them at your deployed base URL and swap in the real API routes and payloads from your contract.

Publishing (Python)

• Build wheel only: python -m build --wheel inside python/.
• Publish to PyPI: twine upload dist/*.whl (set PYPI_API_TOKEN).

GitHub Actions

• .github/workflows/python-publish.yml: builds wheel and uploads to PyPI on tag push or manual dispatch.
• .github/workflows/release-artifacts.yml: builds artifacts for Python (wheel), Node.js (pack), .NET (nupkg), Java (jar), and validates Go; attaches outputs to GitHub Releases on tag pushes.
• .github/workflows/publish-packages.yml: publishes Python (PyPI via PYPI_API_TOKEN), Node.js (npm via NPM_TOKEN), .NET (NuGet via NUGET_API_KEY); placeholders for Packagist and Maven Central included.
• Node.js SDK exposes endpointHelpers.* (auto-generated per endpoint id) alongside callEndpoint.