Crash Course of Wunderlist's API with Guzzle

This article explores how to interact with the Wunderlist API using PHP's Guzzle HTTP client. Wunderlist, a popular task management application, offers an API allowing developers to manage tasks programmatically. This guide demonstrates basic CRUD (Create, Read, Update, Delete) operations.

Key Concepts:

• Wunderlist API: Provides methods to create, read, update, and delete tasks within Wunderlist.
• Guzzle: A PHP HTTP client simplifying API interactions by handling HTTP requests.
• Authentication: Requires creating a Wunderlist application and obtaining an access token.
• Error Handling: Utilizing exception handling within Guzzle to manage HTTP errors.

The Wunderlist API, publicly available since 2015, empowers developers to integrate task management into their applications. This tutorial uses a straightforward PHP approach (without frameworks) and Composer for dependency management. Since there's no official PHP SDK, we leverage Guzzle. A companion demo repository (link provided in original text) showcases a basic implementation with Ajax for task checking.

Setting up the Development Environment:

A composer.json file manages dependencies:

{
    "require": {
        "php": ">=5.5.0",
        "guzzlehttp/guzzle": "~6.0"
    },
    "autoload": {
        "psr-4": {
            "Wunderlist\": "src/"
        }
    },
    "require-dev": {
        "symfony/var-dumper": "~2.7"
    }
}

Create a src/ directory for your PHP classes. Three files are needed: index.php (for API interaction), keys.php (storing API credentials – .gitignore this file!), and .gitignore (to exclude vendor/ and keys.php). .gitignore should contain:

<code>vendor/*
keys.php</code>

Wunderlist Application Setup:

Before coding, create a new application in your Wunderlist account. Provide a dummy App URL and App callback URL (OAuth details are omitted for brevity). Crucially, generate an admin access token—this authenticates your application.

The WunderlistClient Class:

The keys.php file stores your client_id and access_token:

<?php
$client_id = 'your-client-id';
$access_token = 'your-access-token';
?>

The WunderlistClient class (in src/WunderlistClient.php) handles API requests:

<?php

namespace Wunderlist;

use GuzzleHttp\ClientInterface;
use Psr\Http\Message\ResponseInterface;

class WunderlistClient {
    private $client;

    public function __construct(ClientInterface $client) {
        $this->client = $client;
    }

    // ... methods for getLists(), getList(), getListTasks(), createTask(), completeTask() ...  (See below for examples)

    private function checkResponseStatusCode(ResponseInterface $response, $expectedStatusCode) {
        $statusCode = $response->getStatusCode();
        if ($statusCode !== $expectedStatusCode) {
            throw new \RuntimeException('Wunderlist API returned status code ' . $statusCode . ' expected ' . $expectedStatusCode);
        }
    }
}

index.php Example (using WunderlistClient):

require 'vendor/autoload.php';
require_once 'keys.php';

use GuzzleHttp\Client;
use Wunderlist\WunderlistClient;

$guzzle = new Client([
    'base_uri' => 'https://a.wunderlist.com/api/v1/',
    'headers' => [
        'Content-Type' => 'application/json',
        'X-Client-ID' => $client_id,
        'X-Access-Token' => $access_token,
    ]
]);

$wunderlist = new WunderlistClient($guzzle);

try {
    $lists = $wunderlist->getLists();
    // Process $lists
} catch (\Exception $e) {
    // Handle exceptions
}

Example Methods for WunderlistClient (Illustrative):

{
    "require": {
        "php": ">=5.5.0",
        "guzzlehttp/guzzle": "~6.0"
    },
    "autoload": {
        "psr-4": {
            "Wunderlist\": "src/"
        }
    },
    "require-dev": {
        "symfony/var-dumper": "~2.7"
    }
}

Remember to replace placeholder values with your actual client_id and access_token. Implement other CRUD methods similarly, referencing the Wunderlist API documentation. The complete code, including error handling and more advanced features, would be significantly longer. This provides a skeletal structure to get started. Consult the Wunderlist API documentation for details on specific endpoints and request parameters.

The above is the detailed content of Crash Course of Wunderlist's API with Guzzle. For more information, please follow other related articles on the PHP Chinese website!