woeler/komoot-php

A PHP library to interact with Komoot

1.1.0 2024-05-06 16:14 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.8

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.54
• symfony/var-dumper: ^7.0

GPL-3.0-or-later

• Woeler

README

This is a PHP library that can be used to interact with Komoot. It uses the same API the Komoot website uses. It is not officially supported by Komoot to integrate it in third party projects. I just needed a fancy way of interacting with Komoot for a personal project. That is why I created this package.

Usage

Authentication

You will need to use your Komoot account email address and password to log in.

use Woeler\KomootPhp\Api\Komoot;

// Create the api object
$api = new Komoot('[e-mail]', 'my-komoot-password');

// Execute the login
$api->login();

// ... You can now start making api calls

Api calls

The endpoints I deemed important have dedicated methods. After logging in, you can simply use them.

// Get a single tour
$api->getTour(123);

// Get a single tour as GPX data
$api->getTourGpx(123);

// Get all tours of your account
$api->getAllTours();

// Get a single user
$api->getUser(123);

// Get a single collection
$api->getCollection(123);

You may have a look in the Komoot class, various other endpoints are also available.

If you have an endpoint that you wish to call, but it does not have a dedicated method, you can use the customRequest method.

$api->customRequest('https://api.komoot.de/v007/some-other-endpoint', [], 'GET');