README

• API版本：1.1.0
• 软件包版本：1.2.477

更多信息，请访问 http://developers.assembly.education

需求

PHP 5.5 及以上版本

安装 & 使用

Composer

通过 Composer 安装绑定

运行 composer require assembly-edu/assembly-client-php

手动安装

下载文件并包含 autoload.php

  require_once('/path/to//vendor/autoload.php');

测试

运行单元测试

composer install
./vendor/bin/phpunit

入门指南

请按照 安装过程 进行，然后运行以下操作

以下变量可以在您的 .env 文件中定义。

ASSEMBLY_ENVIRONMENT=[sandbox / production]
ASSEMBLY_CLIENT_ID=[YOUR_CLIENT_ID]
ASSEMBLY_CLIENT_SECRET=[YOUR_CLIENT_SECRET]

或作为参数传递给 AssemblyAuth 构造函数

[
  'clientId' => [YOUR_CLIENT_ID],
  'clientSecret' => [YOUR_CLIENT_SECRET],
  'environment' => [sandbox / production]
]

请求学校授权

有关更多信息，请访问我们的 开发者文档 网站。 注意： redirectUri 必须与 Assembly 平台上应用程序设置中定义的 uri 匹配。

<?php
  $provider = new \Assembly\Client\Auth\AssemblyAuth([
    'redirectUri' => 'http://example.com/your-redirect-url/',
]);

  $state = ''; // Set a state value that will be link to s chool in your data store.
  $authorizationUrl = $provider->getAuthorizationUrl([
  'scope'      => ['school:required'], // Add additional scopes are required
	'state' => $state
  ]);

  //SaveSateToDataStore is a implementation placeholder which should be replace with your own data storage process.
  SaveSateToDataStore($state);

  // Redirect the user to the authorization URL.
  header('Location: ' . $authorizationUrl);
?>

处理学校授权回调

<?php

  $provider = new \Assembly\Client\Auth\AssemblyAuth([
    'redirectUri' => 'http://example.com/your-redirect-url/',
  ]);

  //GetStateFromDataStore is a implementation placeholder which should be replace with your own data retrieval process.
  $state = GetStateFromDataStore();

  if (empty($_GET['state']) || (empty($state) && $_GET['state'] !== $state)) {
    exit('Invalid state');
  }

  // Try to get an access token using the authorization code grant.
  $accessToken = $provider->getAccessToken('authorization_code', [
    'code' => $_GET['code']
  ]);

  // We have an access token, which we may use in authenticated requests against the service provider's API.
  echo 'Access Token: ' . $accessToken->getToken() . "<br>";
  echo 'Refresh Token: ' . $accessToken->getRefreshToken() . "<br>";
  echo 'Expired in: ' . $accessToken->getExpires() . "<br>";
  echo 'Already expired? ' . ($accessToken->hasExpired() ? 'expired' : 'not expired') . "<br>";

  //SaveTokenToDatastore is a implementation placeholder which should be replace with your own data storage process.
  SaveTokenToDatastore($accessToken->jsonSerialize());

  $accessToken->jsonSerialize() will return the following
  /*
    {
      "access_token": "ABCDE",
      "refresh_token": "WXYZ",
      "token_type": "bearer",
      "level": "school",
      "expires_in": 108000,
      "school_id": 123,
      "scopes": ["school", "students"]
    }
  */
?>

请求学校数据

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$provider = new \Assembly\Client\Auth\AssemblyAuth();

//GetTokenFromDatastore is a implementation placeholder which should be replace with your own data retrieval process.
$accessToken = new \League\OAuth2\Client\Token\AccessToken(GetTokenFromDatastore());

if ($accessToken->hasExpired()) {
  $accessToken = $provider->getAccessToken('refresh_token', ['refresh_token' => $accessToken->getRefreshToken()]);

  //SaveTokenToDatastore is a implementation placeholder which should be replace with your own data storage process.
  SaveTokenToDatastore($accessToken->jsonSerialize())
}

// Configure OAuth2 access token for authorization: SchoolToken
$config = Assembly\Client\Configuration::getDefaultConfiguration($provider);
// $config = $config->setDebug(true);
// $config = $config->setDebugFile('LOCATION_OF_FILE');
$config->setAccessToken($accessToken->getToken());

$handler = new \GuzzleHttp\Handler\StreamHandler();
$client = new \GuzzleHttp\Client(['handler' => $handler]);

$apiInstance = new Assembly\Client\Api\AssemblyApi(
  $client,
  $config
);

try {
  $bulk_results_body = new \Assembly\Client\Model\BulkResultsBody(); // \Assembly\Client\Model\BulkResultsBody | 

  $result = $apiInstance->bulkUpdateResults($bulk_results_body);
  print_r($result);
} catch (Exception $e) {
  echo 'Exception when calling AssemblyApi->bulkUpdateResults: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有 URI 都是相对于 https://api-sandbox.assembly.education

模型文档

• AcademicYear
• AcademicYearTerms
• Assessment
• AssessmentPoint
• Attendance
• AttendanceSummary
• BulkResultResponse
• BulkResultsBody
• CalendarEvent
• Closure
• Contact
• ContactAddress
• ContactStudents
• DietaryNeed
• EmailInfo
• Enrolment
• Exclusion
• Facet
• FsmEntitlement
• Grade
• GradeSet
• Group
• GroupMisSubject
• GroupMisSubjectSubject
• LearningAim
• Lesson
• LessonGroup
• LessonGroupMisSubject
• LessonRooms
• Me
• MeToken
• MedicalCondition
• MisSubject
• MisSubjectSubject
• PpEntitlement
• RegistrationGroup
• Result
• ResultBody
• ResultEntry
• ResultUpdate
• Room
• School
• SchoolStatus
• SenCategory
• SenNeed
• StaffAbsence
• StaffAllowance
• StaffContract
• StaffMember
• StaffMemberAddress
• StaffMemberDemographics
• StaffMemberQualificationInfo
• StaffQualification
• StaffRole
• StaffSalary
• StandardError
• StandardErrorData
• Student
• StudentAddress
• StudentContactRelationship
• StudentContacts
• StudentDemographics
• StudentLanguages
• StudentLearningAims
• StudentMedical
• StudentMedicalCondition
• StudentMedicalNote
• StudentPhoto
• Subject
• Supervisor
• TeachingGroup
• TelephoneNumberInfo
• Timetable
• TimetableDays
• TimetableGroup
• TimetableGroupMisSubject
• TimetableLessons
• TimetablePeriods
• TimetableStructure
• TimetableStructureDays
• TimetableStructurePeriods
• TimetableSupervisors
• YearGroup

作者

help@assembly.education