README

This API offers you the possibility to calculate and offset emissions, create checkout links, get statistics and much more.

For more information, please visit https://klimapi.com/resources/docs.

Installation

composer require klimapi/php

Setup new API Instance

$klimapi = new KlimAPI\Api\KlimApi('your-private-api-key');

Examples

Create pending Order by Carbon

$pendingByCarbonRequest = new \KlimAPI\Model\PendingByCarbonRequest([
    'kgCO2e' => 200
]);

$order = $klimapi->pendingByCarbon($pendingByCarbonRequest);

Process Order

$processOrder = new \KlimAPI\Model\ProcessOrder([
    'recipientName' => 'Test Customer'
]);
$orderId = 'CA-0000-00000000';

$processed_order = $klimapi->process($processOrder, $orderId);

Methods

Method	HTTP request	Description
addWebhook	POST /webhooks/add	Add Webhook
calculate	POST /calculate	Calculate
calculateCart	POST /stores/{store_ident}/cart	Calculate
getCategories	GET /categories	Get all Categories
getCertificationAuthorities	GET /certification_authorities	Get all Certification Authorities
getMetrics	POST /metrics	Order Metrics
getOrder	GET /orders/{order_id}	Get Order
getOrders	POST /orders	Get Orders
getPaymentLink	GET /orders/link/{payment_link_id}	Get Checkout Link
getProject	GET /projects/{project_id}	Get Project
getProjects	GET /projects	Get all supported Projects
linkByCalculation	POST /orders/link/calculate	By Calculation
linkByCarbon	POST /orders/link/carbon	By Carbon
linkByPrice	POST /orders/link/price	By Price
me	GET /me	Get Authenticated User
orderByCalculation	POST /orders/process/calculate	By Calculation
orderByCarbon	POST /orders/process/carbon	By Carbon
orderByPrice	POST /orders/process/price	By Price
pendingByCalculation	POST /orders/pending/calculate	By Calculation
pendingByCarbon	POST /orders/pending/carbon	By Carbon
pendingByPrice	POST /orders/pending/price	By Price
process	POST /orders/{order_id}/process	Process Pending Order
processCart	POST /stores/{store_ident}/cart/{order_id}/process	Process Cart
refund	DELETE /orders/{order_id}/refund	Refund Order
removeWebhook	DELETE /webhooks/remove	Remove Webhook
syncBulkStore	POST /stores/{store_ident}/sync/bulk	Sync multiple Products
syncStore	POST /stores/{store_ident}/sync	Sync a single Product

klimapi / php

Maintainers

Details