Download the PHP package darvis/supplydrive-api without Composer

Supplydrive API for Laravel

A Laravel client for the Supplydrive API. Supplydrive is a Dutch PEPPOL access point and EDI provider: you send them an invoice, they deliver it. This package sends the invoice and asks their portal what happened to it: by your invoice number, by the message id they answered with, or per debtor.

It does not build the UBL document; darvis/ubl-peppol does that.

Features

• Sending - SupplydriveSender::send($ublXml) posts the document and gives you the message id Supplydrive answered with, the key for its status history. Nothing is retried: a document sent twice is delivered twice
• Login handled - the portal account is exchanged for an access token (OAuth password grant), kept encrypted in Laravel's cache until sixty seconds before it expires
• One new token after a 401 - when the portal refuses a token the client already had, it logs in again and repeats the call once
• Typed results - a Message per item with id, functionalId, status and interfaceId, and a MessageStatus enum for the eight statuses Supplydrive documents, with isDelivered(), isFailed() and isPending()
• Descriptions in English and Dutch - $message->description() in the locale of your application
• Failures with a status - a SupplydriveException with the HTTP status in $e->status(); a 404 is simply an empty list
• Safe with your password - never in a URL, and replaced by [redacted] in error messages, log lines and command output
• Connection tests - php artisan supplydrive:status --functional-id=F260001, php artisan supplydrive:send invoice.xml, and php artisan supplydrive:health, which checks both endpoints without sending anything
• Health checks in code - healthCheck() on the client and the sender never throws and tells you reachable, account accepted, HTTP status and duration
• An MCP server - php artisan mcp:start supplydrive gives Claude and other AI agents the lookup-message-status and explain-statuses tools, registered when laravel/mcp is installed
• Laravel Boost - guideline and skill included, so an AI assistant in your app knows the API

Requirements

• PHP 8.2+
• Laravel 11, 12 or 13
• A Supplydrive portal account with the role for the status endpoint, and for sending the send URL and account; ask Supplydrive for them
• laravel/mcp 1.0 or higher for the MCP server (Laravel Boost installs it)

Installation

The command prints ✓ Connection successful with a table of the messages, or ✗ Request failed: with the reason.

Quick start

Documentation

The full documentation lives on the documentation site:

• Installation: the steps, the settings and how to check that it works
• Quick start: one complete example, a job that records the delivery on the invoice
• Sending: the send account, the message id, and what a timeout means
• How it works: the token, the repeat after a 401, the statuses, timeouts and where the password goes
• API reference: every public method, the enum, the exception and the commands
• Testing: fake Supplydrive in your tests
• MCP server: the handle, the two tools and how to add it to your agent
• Troubleshooting: every message with its cause and its fix
• FAQ: short answers

Laravel Boost

This package ships a guideline and a skill for Laravel Boost. Run php artisan boost:install, or php artisan boost:update --discover in a project that already uses Boost.

Testing

Changelog

See CHANGELOG.

Support the package

If darvis/supplydrive-api saves you time, buy me a beer 🍺: sponsor me on GitHub.

Contributing

See CONTRIBUTING.

Security

Please report a vulnerability privately, as described in SECURITY, not in the issue tracker.

License

The MIT License (MIT). See LICENSE.

This is an unofficial package, not made or endorsed by Supplydrive B.V.