PHPackages dovu/ecoregistry-php - 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. dovu/ecoregistry-php ActiveLibrary[API Development](/categories/api) dovu/ecoregistry-php ==================== Fluent PHP client for the EcoRegistry carbon credit registry API 00TypeScript Since Apr 8Pushed 1mo agoCompare [ Source](https://github.com/dovuofficial/ecoregistry-php-sandbox)[ Packagist](https://packagist.org/packages/dovu/ecoregistry-php)[ RSS](/packages/dovu-ecoregistry-php/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependenciesVersions (2)Used By (0) dovu/ecoregistry-php ==================== [](#dovuecoregistry-php) Fluent PHP client for the [EcoRegistry](https://www.ecoregistry.io/) carbon credit registry API. Built for [DOVU Market](https://app.dovu.market/). Works standalone or with Laravel (auto-discovery). Installation ------------ [](#installation) ``` composer require dovu/ecoregistry-php ``` Quick Start ----------- [](#quick-start) ``` use Ecoregistry\Config; use Ecoregistry\EcoRegistry; $eco = new EcoRegistry(Config::fromArray([ 'email' => 'you@example.com', 'api_key' => 'your-exchange-token', 'platform_token' => 'your-platform-token', ])); // List all projects $projects = $eco->platform()->projects(); // Get Savimbo detail $savimbo = $eco->platform()->project(224); // Get project by code (via frontend API) $detail = $eco->front()->project('CDB-1'); // Account balances $positions = $eco->account()->positions(); ``` Laravel Setup ------------- [](#laravel-setup) The package auto-discovers. Publish the config: ``` php artisan vendor:publish --tag=ecoregistry-config ``` Add to your `.env`: ``` ECOREGISTRY_EMAIL=you@example.com ECOREGISTRY_API_KEY=your-exchange-token ECOREGISTRY_PLATFORM_TOKEN=your-platform-token ``` Then use the facade or inject: ``` // Facade use EcoRegistry; $projects = EcoRegistry::platform()->projects(); $savimbo = EcoRegistry::front()->project('CDB-1'); // Dependency injection public function index(Ecoregistry\EcoRegistry $eco) { return $eco->platform()->project(224); } ``` API Reference ------------- [](#api-reference) ### `$eco->account()` [](#eco-account) Account Information API. Requires `email` + `api_key`. MethodDescription`positions($lang = 'en')`Account balances and credit positions### `$eco->platform()` [](#eco-platform) Platform Information API. Requires `platform_token`. MethodDescription`projects($lang)`All projects with serials, owners, locations`project(int $id, $lang)`Project detail by numeric ID`shapes(int $projectId, $lang)`Cartographic data URL for a project`withdrawals($lang)`All retirements across the registry`sectors($lang)`Project sectors`industries($lang)`Beneficiary industries### `$eco->front()` [](#eco-front) Frontend API (`api-front.ecoregistry.io`). Richer detail than Platform API — includes media, DMRV, certification timeline. MethodDescription`projects($lang)`All public projects`project(int|string $id, $lang)`Project detail by ID (`224`) or code (`'CDB-1'`)### `$eco->exchange()` [](#eco-exchange) Exchange API. Requires exchange registration with EcoRegistry (`contacto@ecoregistry.io`). MethodDescription`auth()`Authenticate (call first)`projects($lang)`All projects`project(int $id, $lang)`Project by ID`companies($lang)`Account holders on the exchange`positions($lang)`All company balances`retirement()`Fluent retirement builder (see below)`lock($serial, $qty, $lang)`Lock credits`unlock($serial, $qty, $lang)`Unlock credits`transfer($companyId, $serial, $qty, $lang)`Transfer between accounts`retire(array $data, $lang)`Retire credits (tonnes) — returns PDF`retireKg(array $data, $lang)`Retire credits (kg) — returns PDF`transferToEcoregistry($serial, $qty, $lang)`Transfer back to EcoRegistry#### Fluent Retirement [](#fluent-retirement) ``` $eco->exchange()->auth()->retirement() ->serial('CDC_18_5_11_321_14_XX_XA_CO_1_1_2021') ->quantity(10) ->voluntaryCompensation() // or ->corsia(), ->colombianCarbonTax(), ->reason($id) ->endUser( name: 'Buyer Name', countryId: 230, // UK documentTypeId: 1, // ID documentNumber: '12345', ) ->observation('Retired via DOVU Market') ->execute(); ``` ### `$eco->marketplace()` [](#eco-marketplace) Marketplace API. Requires marketplace onboarding with EcoRegistry. MethodDescription`auth()`Authenticate (call first)`retire(array $data, $lang)`Retire credits — returns PDF + transaction ID`certificationPdf($txId, $lang)`Retirement certificate PDF URL`activeProjects(int $mpId, $lang)`Projects in marketplace`countries($lang)`Countries`documentTypes($lang)`Document types`reasonsForUse($lang)`Offset usage reasons`serialEligibility($serial, $lang)`Eligible reasons for a serialConfiguration ------------- [](#configuration) KeyEnv VarRequiredDefault`base_url``ECOREGISTRY_BASE_URL`No`https://api-external.ecoregistry.io/api``front_url``ECOREGISTRY_FRONT_URL`No`https://api-front.ecoregistry.io``email``ECOREGISTRY_EMAIL`Yes—`api_key``ECOREGISTRY_API_KEY`Yes—`platform_token``ECOREGISTRY_PLATFORM_TOKEN`For platform()—`exchange_username``ECOREGISTRY_EXCHANGE_USERNAME`For exchange()—`exchange_password``ECOREGISTRY_EXCHANGE_PASSWORD`For exchange()—`exchange_name``ECOREGISTRY_EXCHANGE_NAME`For exchange()—`exchange_user_api_key``ECOREGISTRY_EXCHANGE_USER_API_KEY`For exchange user ops—`marketplace_name``ECOREGISTRY_MARKETPLACE_NAME`For marketplace()—`marketplace_password``ECOREGISTRY_MARKETPLACE_PASSWORD`For marketplace()—The `api_key` is the "Token API Exchanges" from your EcoRegistry dashboard (My Company > Connectivity). Auth ---- [](#auth) Account auth happens automatically — the client fetches a 5-minute JWT on first use and caches it. The Platform API uses a static token (`x-api-key` header), no JWT needed. Exchange and Marketplace APIs have their own auth flows via `auth()`. Status ------ [](#status) APIProductionUAT/DevAccount (auth, positions)WorkingWorkingPlatform (projects, sectors, industries, withdrawals)Working—Frontend (project list, detail)Working—Exchange admin (auth, projects, companies, positions)Pending credentialsWorkingExchange user (retirement, lock, transfer)Pending credentialsPending — user endpoint auth under investigation with EcoRegistryMarketplacePending onboarding—Web Explorer UI --------------- [](#web-explorer-ui) A Next.js debug/demo app that exercises the PHP SDK. Browse projects, view positions, execute retirements, and inspect API responses — all through a browser. ### Prerequisites [](#prerequisites) - PHP 8.1+ with `ext-curl` and `ext-json` - Node.js 18+ - Composer dependencies installed (`composer install`) ### Setup [](#setup) ``` # 1. Install PHP SDK dependencies (if not already done) composer install # 2. Install web dependencies cd web npm install # 3. Configure .env (copy from example and fill in credentials) cp .env.example .env ``` ### Running [](#running) ``` # Start the web UI (from project root) cd web npm run dev ``` Open ****. ### Environment Variables [](#environment-variables) The web app reads from the root `.env` file. Required variables: ``` ; UAT API UAT_BASE_URL="https://api-ecoregistry-dev.ecoregistry.io/api" ; Exchange admin (shared across accounts) UAT_EXCHANGE_USERNAME="..." UAT_EXCHANGE_PASSWORD="..." UAT_EXCHANGE_NAME="..." ; General account (exchange owner) GENERAL_EMAIL="generalaccount@yopmail.com" GENERAL_API_KEY="" GENERAL_COMPANY_ID="ECOxC_..." GENERAL_TOKEN_API_EXCHANGES="" ; User account (e.g. Dovu test 1) USER_EMAIL="dovutest1@yopmail.com" USER_API_KEY="" USER_COMPANY_ID="ECOxC_..." USER_TOKEN_API_EXCHANGES="" ; Production (read-only, for Production Preview tab) PLATFORM_TOKEN="" ``` **Account switching**: The dropdown in the nav bar switches between `GENERAL_*` and `USER_*` credentials. Each account uses different APIs for positions: AccountPositions APIRetirementGeneralExchange admin API (`/api-exchange-v2/v2/get-all-positions`)Works via admin JWTUserAccount API (`/api-account/v1/positions`)Blocked — `x-api-key` auth under investigation### Features [](#features) TabDescription**Projects**Exchange project cards with credit stats**Positions**Serial balances for the selected account**History**Local transaction log of retirements executed through the UI**Production Preview**Read-only view of 229 production projects with full detail (serials, SDGs, vintages)**Debug**Custom auth testing — paste tokens, pick endpoints, fire requests### Architecture [](#architecture) ``` Browser → Next.js API routes → PHP CLI scripts (web/php/) → EcoRegistry API ↓ Uses the PHP SDK (src/) ``` The PHP SDK is the system under test. Each API route shells out to a PHP script that uses the SDK, outputs JSON, and the Next.js route returns it to the browser. Tests ----- [](#tests) ``` # Unit tests (mocked, no API calls) vendor/bin/phpunit --testsuite Unit # Integration tests (hits UAT API, needs .env) vendor/bin/phpunit --testsuite Integration # All vendor/bin/phpunit ``` ### Health Score 20 — LowBetter than 13% of packages Maintenance59 Moderate activity, may be stable Popularity0 Limited adoption so far Community6 Small or concentrated contributor base Maturity13 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/f41786c5820938f0ae46c4efeee6c56b866ce7dc91c7bb571b98f92c84493ae5?d=identicon)[mattsmithies](/maintainers/mattsmithies) --- Top Contributors [![mattsmithies](https://avatars.githubusercontent.com/u/6974163?v=4)](https://github.com/mattsmithies "mattsmithies (36 commits)") ### Embed Badge ![Health badge](/badges/dovu-ecoregistry-php/health.svg) ``` [![Health](https://phpackages.com/badges/dovu-ecoregistry-php/health.svg)](https://phpackages.com/packages/dovu-ecoregistry-php) ``` ### Alternatives [facebook/php-business-sdk PHP SDK for Facebook Business 90923.5M35](/packages/facebook-php-business-sdk)[hubspot/api-client Hubspot API client 24015.5M18](/packages/hubspot-api-client)[botman/driver-telegram Telegram driver for BotMan 93452.6k6](/packages/botman-driver-telegram) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)