Skip to content

Latest commit

History

History
233 lines (214 loc) · 14.5 KB

File metadata and controls

233 lines (214 loc) · 14.5 KB

klimapi-python

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

  • API version: v2
  • Package version: 1.1.29

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

Requirements

Python 3.7+

Installation

pip install

If the python package is hosted on a repository, you can install directly using:

pip install klimapi-python

(you may need to run pip with root permission: sudo pip install klimapi-python)

Then import the package:

importklimapi_python

Setup new API Instance

importklimapi_pythonklimapi=klimapi_python.KlimApi('your-private-api-key')

Methods

MethodHTTP requestDescription
add_webhookPOST /webhooks/addAdd Webhook
calculatePOST /calculateCalculate
calculate_cartPOST /stores/{store_ident}/cartCalculate
get_categoriesGET /categoriesGet all Categories
get_certification_authoritiesGET /certification_authoritiesGet all Certification Authorities
get_metricsPOST /metricsOrder Metrics
get_orderGET /orders/{order_id}Get Order
get_ordersPOST /ordersGet Orders
get_payment_linkGET /orders/link/{payment_link_id}Get Checkout Link
get_projectGET /projects/{project_id}Get Project
get_projectsGET /projectsGet all supported Projects
link_by_calculationPOST /orders/link/calculateBy Calculation
link_by_carbonPOST /orders/link/carbonBy Carbon
link_by_pricePOST /orders/link/priceBy Price
meGET /meGet Authenticated User
order_by_calculationPOST /orders/process/calculateBy Calculation
order_by_carbonPOST /orders/process/carbonBy Carbon
order_by_pricePOST /orders/process/priceBy Price
pending_by_calculationPOST /orders/pending/calculateBy Calculation
pending_by_carbonPOST /orders/pending/carbonBy Carbon
pending_by_pricePOST /orders/pending/priceBy Price
processPOST /orders/{order_id}/processProcess Pending Order
process_cartPOST /stores/{store_ident}/cart/{order_id}/processProcess Cart
refundDELETE /orders/{order_id}/refundRefund Order
remove_webhookDELETE /webhooks/removeRemove Webhook
sync_bulk_storePOST /stores/{store_ident}/sync/bulkSync multiple Products
sync_storePOST /stores/{store_ident}/syncSync a single Product

Models