https://github.com/beedooedtech/beedoo-sdk-php
Esse SDK em PHP foi desenvolvido no intuito de tornar mais prático a integração com nossa API.
https://github.com/beedooedtech/beedoo-sdk-php
api beedoo beedooedtech composer packagist php sdk sdk-php
Last synced: 8 months ago
JSON representation
Esse SDK em PHP foi desenvolvido no intuito de tornar mais prático a integração com nossa API.
- Host: GitHub
- URL: https://github.com/beedooedtech/beedoo-sdk-php
- Owner: beedooedtech
- Created: 2021-09-23T12:46:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-01T21:21:37.000Z (10 months ago)
- Last Synced: 2025-09-07T01:44:21.871Z (9 months ago)
- Topics: api, beedoo, beedooedtech, composer, packagist, php, sdk, sdk-php
- Language: PHP
- Homepage: https://www.beedoo.com.br/
- Size: 52.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sobre Beedoo SDK
Acessar documentação completa da [Beedoo API](http://document-api.beedoo.io.s3-website-us-east-1.amazonaws.com).
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](#instalação)
- [Configuração](#configuração)
- [BeeHub API](#beehub-api)
- [Wiki](#beehub-wiki)
- [Consultar artigos na Wiki](#consultar-artigos-na-wiki)
- [User](#beehub-user)
- [Access Token](#access-token)
- [Beedoo API](#beedoo-api)
- [Groups](#groups)
- [Consultar grupos](#consultar-grupos)
- [Wiki](#beedoo-wiki)
- [Retorna se um determinado artigo foi lido](#retorna-se-um-determinado-artigo-lido)
- [Marca um artigo como lido](#marca-um-artigo-como-lido)
- [Team](#team)
- [Retornar os avatares do time](#retornar-os-avatares-do-time)
- [Upload](#upload)
- [Retornar uma URL pre assinada para upload de arquivos para o S3](#retornar-uma-URL-pre-assinada-para-upload-de-arquivos-para-o-S3)
- [Visual Identity](#visual-identity)
- [Retornar a identidade visual do time](#retornar-a-identidade-visual-do-time)
- [User](#beedoo-user)
- [Cadastrar novo usuário](#cadastrar-novo-usuário)
- [Atualizar novo usuário](#atualizar-usuário)
# Instalação
Instale a biblioteca utilizando o comando:
```shell
composer require beedooedtech/beedoo-sdk-php
```
## Configuração
Para incluir a biblioteca em seu projeto, basta fazer o seguinte:
```php
"assunto_a_ser_pesquisado",
"category" => 1,
"tag" => 5,
"offset" => 20,
"limit" => 20,
];
$groups = $beedoo->groups()->get($params);
```
## BeeHub User
### Access Token
```php
"n6XSN0o6FDQZQ4lmxb7P2"
];
$accessToken = $beedoo->accessToken()->get($payloadAuth);
```
# Beedoo API
## Groups
### Consultar grupos
```php
1,
"name" => "nome_do_grupo",
"offset" => 5,
"limit" => 20,
];
$groups = $beedoo->groups()->get($params);
```
## Beedoo Wiki
### Retorna se um determinado artigo foi lido
```php
279
];
$beedoo = $beedoo->wiki()->getIsReadArticle($article);
```
### Marca um artigo como lido
```php
279
];
$beedoo = $beedoo->wiki()->saveArticleRead($article);
```
## Team
### Retornar os avatares do time
```php
team()->getAvatar();
```
## Upload
### Retornar uma URL pre assinada para upload de arquivos para o S3
```php
upload()->getUrl();
```
## Visual Identity
### Retornar a identidade visual do time
```php
visualIdentity()->get();
```
## Beedoo User
### Cadastrar novo usuário
```php
"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
"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