designcoda/adpanel-connector-laravel

1.2.0 2021-08-04 10:40 UTC

This package is auto-updated.

Last update: 2024-09-04 17:29:43 UTC


README

需求

  • PHP >= 7.2
  • Laravel >= 5.8

描述

此插件通过REST API将您的Laravel项目数据发送到Adpanel。您可以调整发送的数据。

安装

Composer

composer require designcoda/adpanel-connector-laravel

Laravel

  1. 运行发布命令,将配置文件复制到配置文件夹。
php artisan vendor:publish --provider="DesignCoda\AdpanelConnector\AdpanelConnectorServiceProvider" --tag="adpanel-connector"  
  1. 使用命令生成授权令牌
php artisan adpanel:generate_token  

并将控制台中的变量复制到.env文件

  1. 编辑config/adpanel_connector.php以满足您的需求。

  2. 运行以清除缓存

php artisan config:clear
php artisan config:cache  
php artisan route:clear
  1. 在浏览器中访问yoursite.url/adpanel_connector以查看响应。如果您添加令牌yoursite.url/adpanel_connector?token=token_from_env,您将看到带有数据的授权响应。

Laravel

  1. 启动发布文件配置的命令以将其复制到配置文件夹
php artisan vendor:publish --provider="DesignCoda\AdpanelConnector\AdpanelConnectorServiceProvider" --tag="adpanel-connector" --force  
  1. 使用命令生成授权令牌
php artisan adpanel:generate_token  

并将结果复制到.env文件

  1. 根据您的需求编辑config/adpanel_connector.php文件。

  2. 使用命令清除缓存

php artisan config:clear
php artisan config:cache  
php artisan route:clear
  1. 在浏览器中打开yoursite.url/adpanel_connector以查看响应。如果您添加令牌yoursite.url/adpanel_connector?token=token_from_env,您将看到带有数据的授权响应。

查询参数

要接收数据,需要有效的授权令牌。但您还可以传递额外的参数,例如排序
from - 从Y-m-d开始(包括)的created_at列。必须是一个有效的日期
to - 直到Y-m-d(包括)的created_at列。必须是一个有效的日期
order_by - 排序列。如果列不存在,则忽略该参数。必须是一个字符串
desc - 仅与order_by一起使用。必须是一个布尔值
filters - 用于过滤查询的字段。必须是一个数组(例如,filters['like']['utm']['utm_source']['campaign1', 'campaign2']) 对于字段 utm_sourceutm->utm_source(JSON)如 'campaign1' 或 'campaign2'
filters['equal']['utm']['utm_source']['campaign1', 'campaign2']) 对于字段 utm_sourceutm->utm_source(JSON)'campaign1' 或 'campaign2' )

查询参数

要接收数据,需要有效的授权令牌。但您也可以传递额外的参数,例如排序
from - 从Y-m-d开始(包括)的created_at列。必须是一个有效的日期
to - 直到Y-m-d(包括)的created_at列。必须是一个有效的日期
order_by - 排序列。如果列不存在,则忽略该参数。必须是一个字符串
desc - 仅与order_by一起使用。必须是一个布尔值
filters - 用于过滤查询的字段。必须是一个数组(例如,filters['utm']['utm_source']) 对于字段 utm_sourceutm->utm_source(JSON)

响应示例

{
    "status":"failure",
    "status_code":400,
    "message":"Bad Request",
    "errors": {
        "token": [
            "Auth token must be set in .env file. Run console command 'php artisan adpanel:generate_token' and edit your .env file or check published config file.",
            "Token is invalid."
        ]
    }
}
Array
(
    [0] => Array
        (
            [name] => requests
            [columns] => Array
                (
                    [0] => id
                    [1] => utm
                    [2] => login
                    [3] => created_at
                )

            [errors] => Array
                (
                    [0] => Column «login» not exists in table «requests».
                )

            [data] => Illuminate\Support\Collection Object
                (
                    [items:protected] => Array
                        ( ... )
                )
        )
)        

响应示例

{
    "status":"failure",
    "status_code":400,
    "message":"Bad Request",
    "errors": {
        "token": [
            "Токен для авторизации должен быть указан в .env-файле. Запустите команду 'php artisan adpanel:generate_token' и внесите токен в ваш .env-файл или проверьте, опубликован ли файл конфигурации.",
            "Параметр «Токен» неверный."
        ]
    }
}
Array
(
    [0] => Array
        (
            [name] => requests
            [columns] => Array
                (
                    [0] => id
                    [1] => utm
                    [2] => login
                    [3] => created_at
                )

            [errors] => Array
                (
                    [0] => Столбец «login» в таблице «requests» не найден.
                )

            [data] => Illuminate\Support\Collection Object
                (
                    [items:protected] => Array
                        ( ... )
                )
        )
)        

许可证

GNU GPLv3
版权所有 Alexanyasha