Laravel Vendus

Configuration

The package is configured through environment variables (see config/vendus.php):

VENDUS_API_KEY=your-api-key
VENDUS_APP_URL=https://your-account.vendus.pt
VENDUS_MODE=tests
VENDUS_BASE_URL=https://www.vendus.pt/ws/v1.1/

API key

VENDUS_API_KEY is the only required setting — every request against the Vendus API is authenticated with it. You can find it in the Vendus backoffice under your account's integration settings. If it is missing, VendusResource fails loudly with an InvalidArgumentException instead of firing unauthenticated requests.

App URL

VENDUS_APP_URL is the URL you use to access the Vendus web application. Every Vendus account lives on its own subdomain (e.g. https://your-account.vendus.pt), so this value is account-specific — there is no global default. It is only used by getDetailPageLink() to build links from your application straight to a synced record's detail page in the Vendus backoffice:

$customer->getDetailPageLink();
// https://your-account.vendus.pt/clients/detail/id/123

Mode

Vendus can register sales documents in two modes: normal (real, certified documents) and tests (draft documents that are not certified nor communicated to the tax authority). The config value — tests by default, so a fresh install can never issue real invoices by accident — is yours to pass when creating documents:

'mode' => config('vendus.mode'),

Set VENDUS_MODE=normal in production.

Base URL

VENDUS_BASE_URL points at Vendus API v1.1 by default. You will rarely need to change it — the client is written against v1.1, so pointing it at a different API version is not supported. The override exists for two reasons: Vendus serves the same API on country-specific hosts (e.g. https://www.vendus.cv/ws/v1.1/ for Cape Verde accounts), and test suites can point the client at a fake host so no real API calls are ever made.

Publishing the config file

To tweak the configuration beyond what the environment variables cover, publish the config file:

php artisan vendor:publish --provider="CodeTech\Vendus\Providers\VendusServiceProvider" --tag=config

The package also ships translations, publishable with the translations tag.