Skip to content

xnetmobile/api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 

Repository files navigation

XNET API

Welcome to the XNET API—the public interface for managing and retrieving information about XNET resources. This is the beginning of a massive XNET core API system designed to evolve over time.


Documentation for this API can be found on our website at https://docs.xnet.company/tech/api/documentation

Overview

The XNET API is a unified public interface designed to empower XNET participants with seamless programmatic access to a wide range of digital resources. Built to manage and retrieve information about devices, venues, wallets, organizations, and user accounts, this API serves as the backbone of the emerging XNET core system.

Key Highlights:

  • Resource Management:
    The primary focus of the current version (v1.0) is on managing critical XNET assets—making it easier for deployers and organizations to maintain, monitor, and update devices, venues, and related components.

  • Future-Ready:
    While v1.0 concentrates on resource management, future iterations of the API promise enhanced functionality—including a revamped explorer tool in v2.0, live usage and accounting statistics in v3.0, and continuous upgrades in subsequent versions.

The XNET API is not just about data retrieval—it’s about providing a dynamic, scalable platform that evolves with the needs of its users, ensuring efficient resource management today and delivering innovative tools for tomorrow.

Current Version (v0.1)

v0.1 is unstable and subject to breaking changes. Please wait for v1.0 before building with this API.

  • Note: This version is subject to change until it is fully released as v1.0.

Version (v1.0)

  • In the final phases of development.
  • Primarily focused on resource retrieval and management.

Future Roadmap

  • v2.0: Revamped explorer tool.
  • v3.0: Live usage and accounting statistics.
  • v4.0 & Beyond: Continuous upgrades and improvements.

Getting Started

  • Base URL:
    Base URL will be active once v1.0 is released. https://api.xnet.company

  • Authentication:
    All endpoints (except login) require a valid bearer token. Tokens are obtained via the /auth/login endpoint.

  • API Specification:
    This API is defined using the OpenAPI 3.0.3 specification. You can explore the full details of endpoints, schemas, and responses in the provided spec.


Conclusion

The XNET API is your gateway to accessing and managing a wide range of XNET resources. As the system evolves, you can expect more features and improvements. Stay tuned for future releases as we roll out enhanced functionalities and tools.

For more detailed information on each endpoint, refer to the full OpenAPI documentation provided on our website at https://docs.xnet.company/tech/api/documentation .

Happy coding!

Releases

No releases published

Packages

No packages published