Ускоренный курс API Wunderlist с Guzzle

Как только у нас будут все наши списки и мы определим идентификатор того, который нам нужен, мы сможем вернуть больше информации о нем:

 /** * Returns a specific list * * @param int $id * * @return mixed */ public function getList($id) { if (!is_numeric($id)) { throw new \InvalidArgumentException('The list id must be numeric.'); } $response = $this->client->get('lists/' . $id); $this->checkResponseStatusCode($response, 200); return json_decode($response->getBody(), true); } 

Здесь мы делаем базовую проверку, чтобы увидеть, является ли идентификатор числовым, убедитесь, что запрос был успешным, и возвращаем декодированный ответ JSON из API Wunderlist. Теперь внутри index.php :

 try { $list = $wunderlist->getList($id); dump($list); } catch(\Exception $exception) { dump($exception); } 

Мы должны увидеть некоторую информацию о самом списке.

Но что, если мы хотим загрузить все задачи из этого списка? Мы можем реализовать что-то вроде этого:

 /** * Return all the tasks of a given list * * @param int $list_id * * @return array() */ public function getListTasks($list_id) { if (!is_numeric($list_id)) { throw new \InvalidArgumentException('The list id must be numeric.'); } $response = $this->client->get('tasks', ['query' => ['list_id' => $list_id]]); $this->checkResponseStatusCode($response, 200); return json_decode($response->getBody()); } 

Чтобы указать, для какого списка мы хотели бы, чтобы задачи были возвращены, нам нужно передать его идентификатор в качестве параметра запроса в запрос GET. Остальное примерно так же, как и раньше. Внутри index.php мы можем отлаживать все данные, относящиеся к (незавершенным) задачам из этого списка:

 try { $tasks = $wunderlist->getListTasks($id); dump($tasks); } catch(\Exception $exception) { dump($exception); } 

Создание и обновление данных с помощью Wunderlist API

Все запросы, которые мы сделали до сих пор, были GET-вызовами для загрузки информации. Давайте попробуем сделать несколько, с помощью которых мы создаем и обновляем ресурсы с помощью API. Для начала мы можем создать такую ​​задачу:

 /** * Creates a new task * * @param string $name * @param int $list_id * @param array $task * * @return mixed */ public function createTask($name, $list_id, $task = []) { if (!is_numeric($list_id)) { throw new \InvalidArgumentException('The list id must be numeric.'); } $task['name'] = $name; $task['list_id'] = $list_id; $response = $this->client->post('tasks', ['body' => json_encode($task)]); $this->checkResponseStatusCode($response, 201); return json_decode($response->getBody()); } 

Данные новой задачи должны быть отправлены в теле запроса POST в виде JSON. Чтобы использовать этот метод внутри index.php , мы можем сделать что-то вроде этого:

 try { $created = $wunderlist->createTask('My new task', 'the-list-id'); dump($created); } catch(\Exception $exception) { dump($exception); } 

Это только два обязательных параметра, которые должны существовать в задаче, которую мы отправляем в Wunderlist, но мы, конечно, можем добавить больше в массив, передаваемый в качестве третьего параметра нашему методу. Не стесняйтесь проверить соответствующую страницу документации для получения дополнительной информации.

Если все идет хорошо, Wunderlist возвращает статус 201 ( Создан ). И что мы здесь возвращаем, это массив информации, связанной с только что созданной задачей. Это то, что мы можем проверить в браузере, если загрузим index.php .

Чтобы теперь обновить задачу, которую мы создали, нам нужно отправить запрос PATCH на его конечную точку только с теми данными, которые мы хотим изменить, и текущей версией (чтобы гарантировать, что разные приложения не перезаписывают данные друг друга). Таким образом, отправляя логическое ИСТИНА для completed свойства задачи, мы, по сути, помечаем его как проверенный. Мы можем создать этот метод, предназначенный для выполнения задач:

 /** * Completes a task * * @param int $task_id * @param int $revision * @return mixed */ public function completeTask($task_id, $revision) { if (!is_numeric($task_id)) { throw new \InvalidArgumentException('The list id must be numeric.'); } elseif (!is_numeric($revision)) { throw new \InvalidArgumentException('The revision must be numeric.'); } $response = $this->client->patch('tasks/' . $task_id, ['body' => json_encode(['revision' => (int) $revision, 'completed' => true])]); $this->checkResponseStatusCode($response, 200); return json_decode($response->getBody()); } 

Конечная точка, которую мы PATCHING, содержит идентификатор задачи, и мы отправляем в качестве тела запроса JSON-представление значений, которые мы хотим изменить в задаче. Как упоминалось ранее, это должно содержать последнюю ревизию ресурса, которую мы можем узнать из getListTasks() который мы написали ранее.

Предполагая, что мы знаем последнюю ревизию и идентификатор задачи в index.php , мы можем выполнить задачу следующим образом:

 try { $response = $wunderlist->completeTask($task_id, $revision); dump($response) } catch(\Exception $exception) { dump($exception); } 

Если все идет хорошо, ответ, который мы получаем в теле, — это JSON-представление нашей задачи, которое мы можем декодировать в массив.

Вывод

Конечно, есть еще много конечных точек и гораздо больше, которые вы можете сделать с каждой конечной точкой. Идите вперед и проверьте страницы документации, чтобы получить обзор всего, что вы можете сделать.

Очень важным аспектом интеграции с Wunderlist является также предоставление пользователям доступа к своей учетной записи Wunderlist. Вы можете сделать это, используя поток OAuth, который мы упоминали ранее — вот несколько уроков о том, как этого добиться.

Наконец, если вам интересно, взгляните на хранилище, где вы можете найти супер крошечное расширение того, что мы обсуждали в этой статье, с помощью которого вы можете предоставить идентификатор списка, распечатать его задачи на экране, а затем отметьте один из них. по одному через Ajax. Выглядит ужасно, но вы должны быть в состоянии понять суть

Вы уже написали приложение Wunderlist? Показать нам!