Weave Code
Integration Laravel Package
scafera/integration
Scafera Integration is a lightweight Laravel package that connects your PHP application to Scafera services. It offers simple configuration, service bindings, and a clean, testable API so you can integrate quickly and reliably without boilerplate, keeping your codebase clean.
External system integration for the Scafera framework
Frequently asked questions about Integration
- How do I install scafera/integration in a Laravel application?
- Install it with Composer using composer require scafera/integration. Laravel package auto-discovery registers the service provider automatically, so no manual entry in config/app.php is required on supported versions. After installing, publish the configuration file with the vendor:publish command if you want to customise defaults. Then set your Scafera credentials in your .env file.
- How do I configure Scafera API credentials and endpoints?
- The package ships a publishable configuration file that holds your credentials and environment-aware endpoint settings. In practice you keep secrets in .env variables and reference them from the config file rather than hardcoding values. Because endpoints are environment-aware, you can point staging and production at different Scafera hosts without changing application code. Run php artisan config:cache after changing values in production.
- Which Laravel and PHP versions does scafera/integration support?
- The package is built for Laravel and installs via normal Composer resolution, so the exact support matrix is defined by the illuminate constraints in its composer.json. Check those constraints on the repository before installing, especially if you are on the newest Laravel major release. If Composer resolves cleanly, your Laravel version is supported by definition. Pin the version in composer.json once you have verified it in a staging environment.
- How do I send an authenticated request with the Scafera client?
- Resolve the client from Laravel's service container, typically by type-hinting it in a constructor or controller method, then call the relevant method for the endpoint you need. Authentication is handled centrally by the client using the configured credentials, so you never build headers by hand. Responses come back through a typed client, which keeps HTTP handling and error mapping out of your controllers. This is the main reason to use the package instead of raw HTTP calls scattered across the codebase.
- Can I fake Scafera API responses in my test suite?
- Yes. The package is designed to be test-friendly, with fakes and dependency injection so you can swap the real client for a fake in your tests. Because the client is bound in the container, you can substitute it in feature tests without touching production configuration or making network calls. That keeps your test suite fast and deterministic. It also lets you assert that outbound requests were made with the expected payloads.
- What events does the package fire during a request lifecycle?
- The package emits Laravel-native events at points in the request lifecycle, so you can hook in using standard listeners. Typical uses are logging outbound calls, capturing timings, or adding tracing and monitoring around Scafera traffic. Register listeners in your EventServiceProvider or use the Event facade's listen method, exactly as you would for framework events. This keeps cross-cutting concerns out of your integration code.
- How does the package handle Scafera API errors and failures?
- HTTP handling is centralised in the client, which maps failed responses into errors your application can catch and act on. That means you handle failures in one place instead of duplicating try/catch logic at every call site. In an API-first application you would typically catch these and translate them into a structured JSON error response with an appropriate status code. Because the handling lives in the client, you can change your error contract in one place.
- Do I have to publish the configuration file to use the package?
- No. The package works with sensible defaults and environment-driven values straight after installation. Publishing the config is optional and mainly useful when you need to override endpoint hosts, tune timeouts, or adjust credential lookups. If you do publish it, remember that published config takes precedence, so keep it in version control and review changes. Always re-run config:cache in production after modifying it.
- How is scafera/integration different from calling the Scafera API with Guzzle directly?
- Calling Guzzle directly works, but you end up re-implementing authentication, base URL handling, error mapping, and logging in every project. This package wraps those concerns behind a typed client bound in Laravel's container, so integration logic lives in one place and is easy to test with fakes. It also gives you publishable configuration and lifecycle events for free. For a single one-off call Guzzle is fine; for an ongoing integration the package reduces boilerplate and drift.
- Is scafera/integration actively maintained and safe for production use?
- The package is versioned with patch releases and follows standard Composer and Laravel package conventions, so you can pin a version and upgrade deliberately. Before committing to it, review recent commits and tagged releases on the GitHub repository, and check that the support matrix matches your Laravel and PHP versions. Run a spike branch against your staging Scafera environment to confirm behaviour. Pinning the version in composer.json protects you from unexpected changes.
Weaver
How can I help you explore Laravel packages today?