schematichq / schematic-php
Schematic API
0.6.0
2024-04-08 20:18 UTC
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
Schematic API
想了解更多信息,请访问 https://schematichq.com。
安装与使用
要求
PHP 7.4 及更高版本。也应与 PHP 8.0 兼容。
安装
您可以通过 Composer 安装 Schematic PHP SDK。在您的项目目录中运行以下命令
composer require schematichq/schematic-php
使用方法
要初始化 Schematic 客户端,请提供一个密钥 API;您可以在 Schematic 网页应用的设置中的 API 密钥部分获取 API 密钥。
<?php require_once 'vendor/autoload.php'; use Schematic\Schematic; $schematic = new Schematic('YOUR_SECRET_API_KEY');
初始化 Schematic 客户端后,您可以使用 SDK 提供的各种 API 类进行 API 调用。
$companies = $schematic->CompaniesApi->listCompanies();
SDK 在 API 错误的情况下抛出异常。您可以在代码中捕获和处理这些异常。
try { $companies = $schematic->CompaniesApi->listCompanies(); // Process the companies } catch (\Exception $e) { // Handle the exception echo 'Error: ' . $e->getMessage(); }
API 端点
通过此客户端库可以访问以下 Schematic API 端点。所有 URI 都相对于 https://api.schematichq.com
模型
- ApiError
- ApiKeyCreateResponseData
- ApiKeyRequestListResponseData
- ApiKeyRequestResponseData
- ApiKeyResponseData
- AudienceRequestBody
- CheckFlagOutputWithFlagKey
- CheckFlagRequestBody
- CheckFlagResponse
- CheckFlagResponseData
- CheckFlagsResponse
- CheckFlagsResponseData
- CompanyDetailResponseData
- CompanyMembershipDetailResponseData
- CompanyMembershipResponseData
- CompanyOverrideResponseData
- CompanyPlanResponseData
- CompanyResponseData
- CountApiKeysParams
- CountApiKeysResponse
- CountApiRequestsParams
- CountApiRequestsResponse
- CountAudienceCompaniesResponse
- CountAudienceUsersResponse
- CountEventSummariesParams
- CountEventSummariesResponse
- CountEventsParams
- CountEventsResponse
- CountFlagChecksParams
- CountFlagChecksResponse
- CountResponse
- CreateApiKeyRequestBody
- CreateApiKeyResponse
- CreateCompanyOverrideRequestBody
- CreateCompanyOverrideResponse
- CreateCompanyResponse
- CreateEntityTraitDefinitionRequestBody
- CreateEnvironmentRequestBody
- CreateEnvironmentResponse
- CreateEventBatchRequestBody
- CreateEventBatchResponse
- CreateEventRequestBody
- CreateEventResponse
- CreateFeatureRequestBody
- CreateFeatureResponse
- CreateFlagRequestBody
- CreateFlagResponse
- CreateOrUpdateConditionGroupRequestBody
- CreateOrUpdateConditionRequestBody
- CreateOrUpdateFlagRequestBody
- CreateOrUpdateRuleRequestBody
- CreatePlanEntitlementRequestBody
- CreatePlanEntitlementResponse
- CreatePlanRequestBody
- CreatePlanResponse
- CreateReqCommon
- CreateUserResponse
- DeleteApiKeyResponse
- DeleteAudienceResponse
- DeleteCompanyByKeysResponse
- DeleteCompanyMembershipResponse
- DeleteCompanyOverrideResponse
- DeleteCompanyResponse
- DeleteEnvironmentResponse
- DeleteFeatureResponse
- DeleteFlagResponse
- DeletePlanEntitlementResponse
- DeletePlanResponse
- DeleteResponse
- DeleteUserByKeysResponse
- DeleteUserResponse
- EntityKeyResponseData
- EntityTraitDefinitionResponseData
- EnvironmentDetailResponseData
- EnvironmentResponseData
- EventBody
- EventBodyIdentify
- EventBodyIdentifyCompany
- EventBodyTrack
- EventListResponseData
- EventResponseData
- EventSummaryResponseData
- FeatureDetailResponseData
- FeatureResponseData
- FlagCheckLogDetailResponseData
- FlagCheckLogResponseData
- FlagDetailResponseData
- FlagResponseData
- GetApiKeyResponse
- GetApiRequestResponse
- GetCompanyOverrideResponse
- GetCompanyResponse
- GetEnvironmentResponse
- GetEventResponse
- GetEventSummariesParams
- GetEventSummariesResponse
- GetEventSummaryBySubtypeResponse
- GetFeatureResponse
- GetFlagCheckResponse
- GetFlagResponse
- GetLatestFlagChecksParams
- GetLatestFlagChecksResponse
- GetOrCreateCompanyMembershipRequestBody
- GetOrCreateCompanyMembershipResponse
- GetOrCreateEntityTraitDefinitionResponse
- GetPlanEntitlementResponse
- GetPlanResponse
- 获取用户响应
- 密钥请求体
- 列出API密钥参数
- 列出API密钥响应
- 列出API请求参数
- 列出API请求响应
- 列出受众公司响应
- 列出受众用户响应
- 列出公司参数
- 列出公司响应
- 列出公司成员资格参数
- 列出公司成员资格响应
- 列出公司覆盖参数
- 列出公司覆盖响应
- 列出公司计划参数
- 列出公司计划响应
- 列出事件参数
- 列出事件响应
- 列出功能参数
- 列出功能响应
- 列出标志检查参数
- 列出标志检查响应
- 列出标志参数
- 列出标志响应
- 列出指标计数参数
- 列出指标计数响应
- 列出计划权限参数
- 列出计划权限响应
- 列出计划参数
- 列出计划响应
- 列出用户参数
- 列出用户响应
- 查找公司参数
- 查找公司响应
- 查找用户参数
- 查找用户响应
- 每小时指标计数响应数据
- 分页过滤器
- 计划受众详情响应数据
- 计划受众响应数据
- 计划权限响应数据
- 计划响应数据
- 原始事件批量响应数据
- 原始事件响应数据
- 规则条件组详情响应数据
- 规则条件组响应数据
- 规则条件响应数据
- 规则详情响应数据
- 规则响应数据
- 规则详情响应数据
- 更新API密钥请求体
- 更新API密钥响应
- 更新受众请求体
- 更新受众响应
- 更新公司覆盖请求体
- 更新公司覆盖响应
- 更新实体特征定义请求体
- 更新实体特征定义响应
- 更新环境请求体
- 更新环境响应
- 更新功能请求体
- 更新功能响应
- 更新标志响应
- 更新标志规则请求体
- 更新标志规则响应
- 更新计划权限请求体
- 更新计划权限响应
- 更新计划请求体
- 更新计划响应
- 更新请求通用
- 更新规则请求体
- 插入或更新公司请求体
- 插入或更新公司响应
- 插入或更新公司特征响应
- 插入或更新特征请求体
- 插入或更新用户请求体
- 插入或更新用户响应
- 插入或更新用户子请求体
- 插入或更新用户特征响应
- 用户详情响应数据
- 用户响应数据
作者
支持
如果您在使用Schematic PHP SDK时遇到任何问题或有任何疑问,请通过support@schematic.com联系我们的支持团队。