Sobre Beedoo SDK
Acessar documentação completa da Beedoo API.
A API é organizada seguindo a arquitetura REST, boas práticas, convenções e padrões como json:api e JSend. Nossa API tem URLs orientadas a recursos, retorna respostas em JSON e usa códigos de resposta HTTP padrão, autenticação e verbos.
Esse SDK em PHP foi desenvolvido no intuito de tornar mais prático a integração com nossa API.
Bom desenvolvimento!
Índice
Instalação
Instale a biblioteca utilizando o comando:
composer require beedooedtech/beedoo-sdk-php
Configuração
Para incluir a biblioteca em seu projeto, basta fazer o seguinte:
<?php
require __DIR__ . "/vendor/autoload.php"
$beedoo = new Beedoo\Client("SECRET_KEY");
BeeHub API
BeeHub Wiki
Consultar artigos na Wiki
<?php
$params = [
"question" => "assunto_a_ser_pesquisado",
"category" => 1,
"tag" => 5,
"offset" => 20,
"limit" => 20,
];
$groups = $beedoo->groups()->get($params);
BeeHub User
Access Token
<?php
$payloadAuth = [
"clientId" => "n6XSN0o6FDQZQ4lmxb7P2"
];
$accessToken = $beedoo->accessToken()->get($payloadAuth);
Beedoo API
Groups
Consultar grupos
<?php
$params = [
"id" => 1,
"name" => "nome_do_grupo",
"offset" => 5,
"limit" => 20,
];
$groups = $beedoo->groups()->get($params);
Beedoo Wiki
Retorna se um determinado artigo foi lido
<?php
$article = [
'id' => 279
];
$beedoo = $beedoo->wiki()->getIsReadArticle($article);
Marca um artigo como lido
<?php
$article = [
'id' => 279
];
$beedoo = $beedoo->wiki()->saveArticleRead($article);
Team
Retornar os avatares do time
<?php
$beedoo = $beedoo->team()->getAvatar();
Upload
Retornar uma URL pre assinada para upload de arquivos para o S3
<?php
$beedoo = $beedoo->upload()->getUrl();
Visual Identity
Retornar a identidade visual do time
<?php
$beedoo = $beedoo->visualIdentity()->get();
Beedoo User
Cadastrar novo usuário
<?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);
Atualizar usuário
<?php
$userData = [
"username" => "jhonsnow",
"name" => "Jhon Snow",
"login" => "jhonsnow",
"email" => "[email protected]",
"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