README

注意：API目前仅限内部使用；SDK仅用于公开审查。

安装

该库可以通过composer进行管理。

composer.json

#!json

{
  "require": {
    "geoop/php-sdk": "0.*"
  }
}

然后，从与composer.json相同的目录中，使用composer.phar从终端安装包

#!

$> composer.phar update geoop/php-sdk

在此库中

Geoop\Core\

ApiContext

这包含对仓库的连接信息。

• companyId - API调用的目标GeoOp公司

• scope - API作用域：["system", "app", "public"]

• token - 用于授权头的API OAuth2令牌。

• url - API调用的基本URI：["https://api.dev.geoop.com", "https://api.test.geoop.com", "https://api.geoop.com"]

• version - API版本 ["v3.0"]

ApiParser

包含将数据在JSON和模型之间进行转换所需函数的类。此类还处理API和SDK之间模型/属性命名的任何差异。

CallHandler

已弃用。

GeoOpConnection

已弃用。

Geoop\Definitions\

此目录包含所有可枚举值和一些复杂可枚举数组，以及大多数静态名词。

Geoop\Interfaces\

SDK消费者期望直接访问的类的接口。

Geoop\Model\

GeoOp模型。虽然某些模型可能没有自己的端点，但此目录中的所有类都是可实例化的。

Geoop\ModelService\

辅助模型的基本功能和非公共属性的辅助类。这些类不可实例化。

Geoop\Repository\

包含所有帮助与API通信的类。只有与相关API端点关联的模型将具有存储库。没有存储库的模型通常必须属于父模型，不能独立存在。这些模型可以通过其父类存储库进行修改。

用法

检索公司

#!php

$apiContext = new ApiContext(
    'https://api.geoop.com',
    'system',
    'v3.0',
    <companyId>,
    <apiToken>
);

$companyRepository = new CompanyRepository($apiContext);

$company = $companyRepository->fetch();