cierrateam/connect-laravel-sdk

此包最新版本(1.0.0)没有提供许可证信息。

CIerra Connect Laravel SDK

1.0.0 2023-08-31 14:53 UTC

This package is auto-updated.

Last update: 2024-09-30 01:54:42 UTC


README

CIerra Connect Laravel SDK 提供了一种简单的方法,将您的 Laravel 应用程序与 CIerra Connect API 集成。

安装

按照以下步骤安装和设置此包

  1. 使用 Composer 安装此包

    composer require cierrateam/connect-laravel-sdk
  2. 将服务提供者添加到您的 config/app.php 文件中的 providers 数组

    'providers' => [
        // ...
        \Cierra\Connect\ConnectServiceProvider::class,
    ],
  3. 发布配置文件(可选)

    php artisan vendor:publish --tag=cierra-connect-config
  4. 将您的 Cierra Connect API 密钥添加到您的 .env 文件中

    CIERRA_CONNECT_KEY=your_api_key_here

将 'your_api_key_here' 替换为您的实际 Cierra Connect API 密钥。

用法示例

以下是一个如何在控制器中使用 Cierra Connect Laravel SDK 的示例

<?php

namespace App\Http\Controllers;

use Cierra\Connect\ConnectManager;
use Illuminate\Http\Request;

class TestCierraConnectController extends Controller
{
    public function test(Request $request, ConnectManager $connectManager)
    {
        $CONNECTION = 'my_api_connection_key';
        $apiClient = $connectManager->getInstance($CONNECTION);

        // Get a list of entities
        $items = $apiClient->entity('cars')->list();
        dump($items); // Laravel collection returned
        dump($items->first());
        
        // Pagination
        $items = $apiClient->entity('cars')->list(4, 100);
        dump($items);

        // Get specific item by ID
        $item = $apiClient->entity('cars')->get(314591);
        dump($item);
        
        // Get additional API response data
        $item = $apiClient->entity('cars')->asRawResponse()->get(314588);
        dump($item);
    }
}