proclame / tblack-it-monday-api
TBLACK-IT开发的Monday v2 API
v0.2.5
2023-12-27 11:26 UTC
Requires
- php: >=7.0
- ext-json: *
This package is auto-updated.
Last update: 2024-09-25 00:12:42 UTC
README
Monday.com API
安装与加载
Monday API可在Packagist上找到(使用语义版本控制),推荐通过Composer进行安装。只需将以下行添加到您的composer.json
文件中
"tblack-it/monday-api": "~0.2"
或运行
composer require tblack-it/monday-api
请注意,vendor
文件夹和vendor/autoload.php
脚本是由Composer生成的;它们不是Monday API的一部分
示例
初始化Monday连接器
<?php require 'vendor/autoload.php'; $token = 'API_TOKEN'; $MondayBoard = new TBlack\MondayAPI\MondayBoard(); $MondayBoard->setToken(new TBlack\MondayAPI\Token($token));
与看板交互
# Get all boards $all_boards = $MondayBoard->getBoards(); # Get Board id : 10012 $board_id = 10012; $board = $MondayBoard->on($board_id)->getBoards(); # Get Board Columns $board_id = 10012; $boardColumns = $MondayBoard->on($board_id)->getColumns(); # Create Board, if success return board_id $newboard = $MondayBoard->create( 'New Board Name', TBlack\MondayAPI\ObjectTypes\BoardKind::PUB ); $board_id = $newboard['create_board']['id'];
与项目项交互
# Insert new Item on Board $board_id = 10012; $id_group = 'topics'; $column_values = [ 'text1' => 'Value...','text2' => 'Other value...' ]; $addResult = $MondayBoard ->on($board_id) ->group($id_group) ->addItem( 'My Item Title', $column_values ); # If you want to use the `create_labels_if_missing` arguments; just add `true` as the third arguments (default: `false`) $addResult = $MondayBoard ->on($board_id) ->group($id_group) ->addItem( 'My Item Title', $column_values, true); # if succes return $item_id = $addResult['create_item']['id']; # For update Item $item_id = 34112; $column_values = [ 'text1' => 'New Value','text2' => 'New other value...' ]; $updateResult = $MondayBoard ->on($board_id) ->group($id_group) ->changeMultipleColumnValues($item_id, $column_values ); # Archive item $result = $MondayBoard ->on($board_id) ->group($id_group) ->archiveItem($item_id); // Delete item $result = $MondayBoard ->on($board_id) ->group($id_group) ->deleteItem($item_id);
如果您需要特定的操作,可以运行自定义查询或突变
// Run a custom query $query = ' boards (ids: 12121212) { groups (ids: group_id) { items { id name column_values { id text title } } } }'; # For Query $items = $MondayBoard->customQuery( $query ); # For Mutation $items = $MondayBoard->customMutation( $query );
获取错误信息
$error = $MondayBoard->error;