README

关于Beedoo SDK

访问Beedoo API的完整文档。

API按照REST架构、良好实践、约定和标准（如json:api和JSend）组织。我们的API具有资源导向的URL，返回JSON格式的响应，并使用HTTP标准响应代码、认证和动词。

此PHP SDK的开发旨在使与我们的API集成更加便捷。

祝您开发愉快！😉

目录

• 安装
• 配置
• BeeHub API
  • Wiki
    • 在Wiki中查看文章
  • 用户
    • 访问令牌
• Beedoo API
  • 组
    • 查询组
  • Wiki
    • 返回是否已阅读指定文章
    • 标记文章为已读
  • 团队
    • 返回团队头像
  • 上传
    • 返回用于上传文件到S3的预签名URL
  • 视觉识别
    • 返回团队视觉识别
  • 用户
    • 注册新用户
    • 更新新用户

安装

使用以下命令安装库

composer require beedooedtech/beedoo-sdk-php

配置

要将库添加到您的项目，请执行以下操作

<?php

require __DIR__ . "/vendor/autoload.php"

$beedoo = new Beedoo\Client("SECRET_KEY");

BeeHub API

BeeHub Wiki

在Wiki中查看文章

<?php

$params = [
  "question" => "assunto_a_ser_pesquisado",
  "category" => 1,
  "tag" => 5,
  "offset" => 20,
  "limit" => 20,
];

$groups = $beedoo->groups()->get($params);

BeeHub 用户

访问令牌

<?php

$payloadAuth = [
    "clientId" => "n6XSN0o6FDQZQ4lmxb7P2"
];

$accessToken = $beedoo->accessToken()->get($payloadAuth);

Beedoo API

组

查询组

<?php

$params = [
  "id" => 1,
  "name" => "nome_do_grupo",
  "offset" => 5,
  "limit" => 20,
];

$groups = $beedoo->groups()->get($params);

Beedoo Wiki

返回是否已阅读指定文章

<?php

$article = [
  'id' => 279
];

$beedoo = $beedoo->wiki()->getIsReadArticle($article);

标记文章为已读

<?php

$article = [
  'id' => 279
];

$beedoo = $beedoo->wiki()->saveArticleRead($article);

团队

返回团队头像

<?php

$beedoo = $beedoo->team()->getAvatar();

上传

返回用于上传文件到S3的预签名URL

<?php

$beedoo = $beedoo->upload()->getUrl();

视觉识别

返回团队视觉识别

<?php

$beedoo = $beedoo->visualIdentity()->get();

Beedoo 用户

注册新用户

<?php

/** Campos obrigatórios */

$userData = [
  "username" => "jhonsnow",
  "name" => "Jhon Snow",
  "login" => "jhonsnow",
  "password" => "123mudar",
  "status" => "Ativo",
  "typeUser" => "Usuário",
  "permission" => "Usuario",
  "groups" => "geral"
];

$user = $beedoo->user()->create($userData);

更新用户

<?php

$userData = [
  "username" => "jhonsnow",
  "name" => "Jhon Snow",
  "login" => "jhonsnow",
  "email" => "jhonsnow@gmail.com",
  "password" => "123mudar",
  "status" => "Ativo",
  "typeUser" => "Usuário",
  "permission" => "Usuario",
  "groups" => "geral, grupo_pela_api",
  "cpf_cnpj" => 46312127800,
  "dashboard" => [
    "agent_id" => 22032,
    "template" => "Template DEV"
  ],
  "hierarchy" => [
    "leader" => 77202,
    "level" => "Gerente" 
  ],
  "language" => "pt-BR",
  "leader" => true,
  "mention_feed" => false,
  "entrytime" => "18:45:00",
  "exittime" => "23:15:00",
  "customfields" => [
    "Login-SSO" => "jhonsnow",
    "Complementar Numero" => 12345
  ]
];

$user = $beedoo->user()->update($userData);

BeeTalk