jeffreyhyer/bamboohr-laravel

Laravel 5.x Service Provider 和 Facade 用于 jeffreyhyer/bamboohr 包

1.0.8 2021-05-05 05:38 UTC

This package is auto-updated.

Last update: 2024-09-05 12:17:02 UTC


README

注意:此包当前需要 PHP >= 7.0.0

如果您需要 PHP 5.x 支持,请通过提交问题(或者您可以随意提交拉取请求)来告知我。

安装

$ composer require jeffreyhyer/bamboohr-laravel

Laravel 5.5+

此包支持自动发现 Service Provider 和 Facade,您可以跳转到下面的 配置 部分。

Laravel <= 5.4

对于 Laravel <= 5.4,您需要在 config/app.php 文件中添加 Service Provider 和 Facade。

<?php

'providers' => [
    // ...
    JeffreyHyer\BambooHR\ServiceProvider::class,
],

'aliases' => [
    // ...
    'BambooHR' => JeffreyHyer\BambooHR\Facade::class,
],

配置

为了访问 BambooHR API,您需要配置公司的子域并提供 API 密钥。

将以下内容添加到 config/services.php 文件中

'bamboohr' => [
    'domain' => env('BAMBOOHR_DOMAIN'),
    'key' => env('BAMBOOHR_APIKEY'),
],

如果您决定使用 .env 文件来存储域名和 API 密钥(推荐),您需要在您的 .env 文件中添加以下内容

BAMBOOHR_DOMAIN=company             # Company Subdomain (e.g. http://COMPANY.bamboohr.com/)
BAMBOOHR_APIKEY=0123456789abcdef    # API Key

使用方法

安装完成后,您应该可以通过 facade 访问 BambooHR API。

<?php

// Get employee directory
BambooHR::employees()->directory();

有关完整 API 文档和附加使用选项,请参阅 https://jeffreyhyer.github.io/bamboohr/