Weave Code
Laravel Package Laravel Package
alfaexchange/laravel-package
Laravel SDK for Alfa Exchange API. Fetch real-time currency exchange rates for 170+ currencies from 15+ data sources, with endpoints for latest rates, conversions, time-series, and fluctuation data. Configure your API key and start querying in minutes.
Laravel package for working with api.alfaexchange.io API service
Frequently asked questions about Laravel Package
- What Laravel versions does this package officially support, and how can I test it with Laravel 9/10?
- The package officially supports Laravel 7 and 8, with the last release in 2022. For Laravel 9/10, you may need minor adjustments like updating dependencies or replacing deprecated helpers (e.g., `str()`). Start by running `composer require alfaexchange/laravel-package` in a fresh Laravel 9/10 project, then test core endpoints like `/accounts` or `/orders` to identify compatibility gaps.
- Does this package handle authentication securely, and how should I store API keys?
- The package assumes API key authentication via AlfaExchange’s standard method. Store credentials securely in your Laravel `.env` file using the `API_KEY` variable, or leverage a secrets manager like AWS Secrets Manager or HashiCorp Vault. Never hardcode keys in your application code or version-controlled files.
- What endpoints or AlfaExchange API features are *not* supported by this package?
- While the package covers core endpoints like accounts, orders, and trades, advanced features such as margin trading, complex analytics, or real-time streaming may not be included. Always cross-reference the [AlfaExchange API docs](https://api.alfaexchange.io/) to confirm coverage. If a feature is missing, you may need to extend the package or use direct API calls.
- How does the package handle rate limits, and what should I do for high-frequency trading?
- The package includes basic rate-limit handling, but it’s designed for moderate usage. For high-frequency trading, you’ll need to implement custom logic, such as exponential backoff or queueing requests via Laravel queues. Monitor AlfaExchange’s rate limits and adjust your application’s concurrency accordingly.
- Can I use this package in a non-Laravel PHP project, or is it Laravel-specific?
- The package is Laravel-specific due to its reliance on Laravel’s service provider pattern and helpers. However, if your non-Laravel PHP project uses Composer and PSR-4 autoloading, you could adapt the core client logic (ignoring Laravel-specific components) or wrap the package in a facade for compatibility.
- Does this package support webhooks or real-time updates from AlfaExchange?
- No, the package does not include built-in webhook or real-time update support. For real-time functionality, you’ll need to implement polling or integrate an external service (e.g., Pusher, Socket.io) to handle AlfaExchange’s webhook events. Check AlfaExchange’s API docs for webhook endpoints and requirements.
- How can I extend the package to add missing features, like custom DTOs or new endpoints?
- Extend the package by creating custom traits, mixins, or overriding service providers. For example, add a new trait to handle margin trading logic or extend the base client class to include unsupported endpoints. Follow Laravel’s package development best practices, such as publishing config files or using facades for cleaner integration.
- What’s the best way to test this package in a production-like environment before full deployment?
- Start by deploying the package in a staging environment with non-critical endpoints (e.g., market data). Use Laravel’s queue system to simulate load and test rate limits. Mock API responses in unit tests to avoid hitting real endpoints, and gradually replace direct API calls with the package’s methods as you validate stability.
- Is there a fallback plan if this package becomes abandoned or unsupported?
- If maintenance stalls, fork the repository and maintain your own version. Alternatively, rewrite critical components (e.g., the API client) as a standalone library. Document your customizations and dependencies to ensure long-term compatibility. Always keep a backup of direct API call logic as a last resort.
- How do I debug issues like failed API requests or unexpected responses from AlfaExchange?
- Enable Laravel’s debug mode and check logs for exceptions thrown by the package. Use `dd()` or `dump()` to inspect DTOs or raw API responses. For AlfaExchange-specific errors, refer to their API documentation for error codes. Wrap API calls in try-catch blocks to log detailed error messages, including HTTP status codes and response bodies.
Weaver
How can I help you explore Laravel packages today?