Skip to content

KlimAPI/klimapi-php

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
.github
.github
 
 
docs
docs
 
 
lib
lib
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 

Repository files navigation

klimapi-php

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

Models

About

KlimAPI API Wrapper for PHP

packagist.org/packages/klimapi/php

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases 10

KlimAPI Release 2.0.14 🚀 Latest
Aug 31, 2024
+ 9 releases

Languages