PHPackages smart-dato/nova-systems-edi-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. smart-dato/nova-systems-edi-sdk ActiveLibrary[API Development](/categories/api) smart-dato/nova-systems-edi-sdk =============================== A Laravel SDK for Nova Systems EDI integration. 0.0.1(5mo ago)0615↓30.6%[2 PRs](https://github.com/smart-dato/nova-systems-edi-sdk/pulls)MITPHPPHP ^8.4CI passing Since Nov 25Pushed 1mo agoCompare [ Source](https://github.com/smart-dato/nova-systems-edi-sdk)[ Packagist](https://packagist.org/packages/smart-dato/nova-systems-edi-sdk)[ Docs](https://github.com/smart-dato/nova-systems-edi-sdk)[ GitHub Sponsors](https://github.com/SmartDato)[ RSS](/packages/smart-dato-nova-systems-edi-sdk/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (15)Versions (4)Used By (0) Nova Systems EDI SDK ==================== [](#nova-systems-edi-sdk) [![Latest Version on Packagist](https://camo.githubusercontent.com/433f1c6c8ae64db5eaa81f74399282129cb45fa86254b68a8fac97376a65afd5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f736d6172742d6461746f2f6e6f76612d73797374656d732d6564692d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/smart-dato/nova-systems-edi-sdk)[![GitHub Tests Action Status](https://camo.githubusercontent.com/9fa0b5e470f56e58b3842703e732b616d6cc883f17cce05d6c07e4a117e9b902/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f736d6172742d6461746f2f6e6f76612d73797374656d732d6564692d73646b2f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/smart-dato/nova-systems-edi-sdk/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/cb428d5b08bd3e5e8f3e799f6f2204e3883de70750ee1937f05ed57b3310c513/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f736d6172742d6461746f2f6e6f76612d73797374656d732d6564692d73646b2f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/smart-dato/nova-systems-edi-sdk/actions?query=workflow%3A%22Fix+PHP+code+style+issues%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/7d4531ec6c5e2e3346f8f8d21094b29d05a2b6a2769ebbb8d36728876e75d3e6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f736d6172742d6461746f2f6e6f76612d73797374656d732d6564692d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/smart-dato/nova-systems-edi-sdk) A Laravel SDK for the Nova Systems EDI API, built with [Saloon](https://docs.saloon.dev/). **API Documentation:** [Nova Systems EDI API Swagger](https://beonews.novasystems.it/api/swagger/index.html?urls.primaryName=EDI) Support us ---------- [](#support-us) [![](https://camo.githubusercontent.com/6ba828d7dfcf5318419f639da40df25f6ac88c253e64f98f4dc9eb47225d5b64/68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6e6f76612d73797374656d732d6564692d73646b2e6a70673f743d31)](https://spatie.be/github-ad-click/nova-systems-edi-sdk) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). Installation ------------ [](#installation) You can install the package via composer: ``` composer require smart-dato/nova-systems-edi-sdk ``` You can publish and run the migrations with: ``` php artisan vendor:publish --tag="nova-systems-edi-sdk-migrations" php artisan migrate ``` You can publish the config file with: ``` php artisan vendor:publish --tag="nova-systems-edi-sdk-config" ``` This is the contents of the published config file: ``` return [ /* |-------------------------------------------------------------------------- | Base URL |-------------------------------------------------------------------------- | | The base URL for the Nova Systems EDI API. | */ 'base_url' => env('NOVA_SYSTEMS_EDI_BASE_URL', 'https://api.novasystems.com'), /* |-------------------------------------------------------------------------- | API Key |-------------------------------------------------------------------------- | | Your Nova Systems EDI API key for X-ApiKey authentication. | */ 'api_key' => env('NOVA_SYSTEMS_EDI_API_KEY'), /* |-------------------------------------------------------------------------- | JWT Token |-------------------------------------------------------------------------- | | JWT token for Bearer token authentication. If set, this will be used | instead of the API key. | */ 'jwt_token' => env('NOVA_SYSTEMS_EDI_JWT_TOKEN'), /* |-------------------------------------------------------------------------- | Request Timeout |-------------------------------------------------------------------------- | | The timeout in seconds for API requests. | */ 'timeout' => env('NOVA_SYSTEMS_EDI_TIMEOUT', 30), ]; ``` Add the following environment variables to your `.env` file: ``` NOVA_SYSTEMS_EDI_BASE_URL=https://api.novasystems.com NOVA_SYSTEMS_EDI_API_KEY=your-api-key NOVA_SYSTEMS_EDI_JWT_TOKEN=your-jwt-token NOVA_SYSTEMS_EDI_TIMEOUT=30 ``` Authentication -------------- [](#authentication) The SDK supports two authentication methods: ### X-ApiKey Authentication [](#x-apikey-authentication) Uses the `X-ApiKey` header with your API key. ### JWT Bearer Authentication [](#jwt-bearer-authentication) Uses the `Authorization` header with a Bearer token: `Bearer {your-jwt-token}`. > **Note:** If both `api_key` and `jwt_token` are configured, JWT authentication takes precedence. Usage ----- [](#usage) ### Via Dependency Injection (Recommended) [](#via-dependency-injection-recommended) The connector is registered as a singleton in the service container and will automatically use credentials from your config: ``` use SmartDato\NovaSystemsEdi\Connectors\NovaSystemsEdiConnector; class MyService { public function __construct( protected NovaSystemsEdiConnector $connector ) {} public function doSomething() { // Use $this->connector to make requests } } ``` ### Via Container [](#via-container) ``` use SmartDato\NovaSystemsEdi\Connectors\NovaSystemsEdiConnector; $connector = app(NovaSystemsEdiConnector::class); ``` ### Static Factory Methods [](#static-factory-methods) Create a connector with specific authentication: ``` use SmartDato\NovaSystemsEdi\Connectors\NovaSystemsEdiConnector; // With API Key authentication $connector = NovaSystemsEdiConnector::withApiKey('your-api-key'); // With API Key and custom base URL $connector = NovaSystemsEdiConnector::withApiKey('your-api-key', 'https://custom-api.com'); // With JWT authentication $connector = NovaSystemsEdiConnector::withJwt('your-jwt-token'); // With JWT and custom base URL $connector = NovaSystemsEdiConnector::withJwt('your-jwt-token', 'https://custom-api.com'); ``` ### Direct Instantiation [](#direct-instantiation) ``` use SmartDato\NovaSystemsEdi\Connectors\NovaSystemsEdiConnector; $connector = new NovaSystemsEdiConnector( apiKey: 'your-api-key', jwtToken: null, baseUrl: 'https://custom-api.com' ); ``` Examples -------- [](#examples) ### Creating a Shipment [](#creating-a-shipment) ``` use SmartDato\NovaSystemsEdi\Connectors\NovaSystemsEdiConnector; use SmartDato\NovaSystemsEdi\Data\PostShipmentRequestData; use SmartDato\NovaSystemsEdi\Data\ShipmentContactData; use SmartDato\NovaSystemsEdi\Data\ShipmentData; use SmartDato\NovaSystemsEdi\Data\ShipmentGoodDetailData; use SmartDato\NovaSystemsEdi\Data\ShipmentGoodDetailSizeData; use SmartDato\NovaSystemsEdi\Data\SubjectData; use SmartDato\NovaSystemsEdi\Enums\ContactSubjectType; use SmartDato\NovaSystemsEdi\Enums\ContactTitle; use SmartDato\NovaSystemsEdi\Enums\DeliveryDateType; use SmartDato\NovaSystemsEdi\Enums\ParcelLabelsGenerationMode; use SmartDato\NovaSystemsEdi\Enums\ShipmentPracticeType; use SmartDato\NovaSystemsEdi\Enums\ShipmentStatusType; use SmartDato\NovaSystemsEdi\Enums\ShipmentSubjectType; use SmartDato\NovaSystemsEdi\Enums\SizeUnitOfMeasure; use SmartDato\NovaSystemsEdi\Requests\PostShipmentRequest; $connector = app(NovaSystemsEdiConnector::class); $requestData = new PostShipmentRequestData( interchangeToken: 'NEW04V0GC831NVCZK81W9S3HMJPC23C', shipmentData: new ShipmentData( serviceCode: 'EE', shipmentPracticeType: ShipmentPracticeType::RoadShipment, deliveryRequestType: DeliveryDateType::NoDeliveryPreference, senderReferenceNumber: '0080070933', editShipmentFullNumber: '01/2025/311916', callerSubjectType: ShipmentSubjectType::Sender, branchCode: '01', shipmentDate: new DateTime('2025-10-22T10:54:44.22Z'), shipmentStatus: ShipmentStatusType::ToBeConfirmed, transportIncotermsCode: '1', sender: new SubjectData( zipCode: '31047', city: 'Levada', countryCode: 'IT', address: 'Via delle Industrie 19', address2: '', companyName: 'La Sportiva C/o Movimoda', province: 'TV', ), senderDocumentCode: 'ORD', consignee: new SubjectData( zipCode: '74700', city: 'Sallanches', countryCode: 'FR', address: 'ROUTE DU FAYET 925', address2: '', companyName: 'AU VIEUX CAMPEUR SALLANCHES', ), consigneeReferenceNumber: '0080070933', isGoodsCollectionRequested: false, parcelLabelQuantity: 9, goodsDetails: [ new ShipmentGoodDetailData( packages: 9, productClassCode: 'AR', goodsDescription: 'Articoli sportivi', goodsAppearanceCode: '01', grossWeight: 154.58, cubeMeters: 1.551, sizes: [ new ShipmentGoodDetailSizeData( packages: 1, sizeUM: SizeUnitOfMeasure::Centimeters, sizeLength: 63, sizeWidth: 38, sizeHeight: 72, grossWeight: 18.26, areStackableGoods: true, ), // ... more sizes ], ), ], contacts: [ new ShipmentContactData( subjectType: ContactSubjectType::Consignee, title: ContactTitle::NotSelected, name: 'AU VIEUX CAMPEUR SALLANCHES', phoneNumber: '+33450912662', languageCode: 'en', ), ], ), parcelLabelsGenerationMode: ParcelLabelsGenerationMode::ZplOneForEachLabel, ); $response = $connector->send(new PostShipmentRequest($requestData)); ``` ### Deleting a Shipment [](#deleting-a-shipment) ``` use SmartDato\NovaSystemsEdi\Data\DeleteShipmentRequestData; use SmartDato\NovaSystemsEdi\Requests\DeleteShipmentRequest; $connector = app(NovaSystemsEdiConnector::class); $requestData = new DeleteShipmentRequestData( interchangeToken: 'NEW04V0GC831NVCZK81W9S3HMJPC23C', serviceCode: 'EE', shipmentFullNumber: '01/2025/311916', ); $response = $connector->send(new DeleteShipmentRequest($requestData)); ``` Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [SmartDato](https://github.com/smart-dato) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 40 — FairBetter than 88% of packages Maintenance81 Actively maintained with recent releases Popularity17 Limited adoption so far Community10 Small or concentrated contributor base Maturity44 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 167d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/c3006db55caec62526937fa2d941da32fc5e69e2ca86a52e87c8046da5958d82?d=identicon)[smart-dato](/maintainers/smart-dato) --- Top Contributors [![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")[![michael-tscholl](https://avatars.githubusercontent.com/u/178569346?v=4)](https://github.com/michael-tscholl "michael-tscholl (1 commits)")[![tschigo](https://avatars.githubusercontent.com/u/344100?v=4)](https://github.com/tschigo "tschigo (1 commits)") --- Tags laravelSmartDatonova-systems-edi-sdk ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/smart-dato-nova-systems-edi-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/smart-dato-nova-systems-edi-sdk/health.svg)](https://phpackages.com/packages/smart-dato-nova-systems-edi-sdk) ``` ### Alternatives [scalar/laravel Render your OpenAPI-based API reference 6183.9k2](/packages/scalar-laravel)[codebar-ag/laravel-docuware DocuWare integration with Laravel 1221.1k](/packages/codebar-ag-laravel-docuware)[codebar-ag/laravel-zammad Zammad integration with Laravel 106.1k](/packages/codebar-ag-laravel-zammad) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)