docplanner / integrations-api-sdk-php
DocPlanner 集成 API SDK
v1.0.35
2023-11-29 21:49 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2|^7.0
This package is auto-updated.
Last update: 2024-09-07 00:17:07 UTC
README
- PHP 5.5 及以上版本
- Guzzle 6.2 及以上版本
安装与使用
Composer
要使用 Composer 安装绑定,运行 composer require docplanner/integrations-api-sdk-php
。
手动安装
下载文件并包含 autoload.php
require_once('/path/to/DocPlanner/Client/vendor/autoload.php');
入门指南
请按照 安装过程 进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); //Get OAuth2 access token $authorization = new DocPlanner\Client\Authorization('https://www.{domain}/oauth/v2/token'); $accessToken = $authorization->getAccessToken('YOUR_CLIENT_ID', 'YOUR_CLIENT_SECRET'); // Configure access token for authorization $config = DocPlanner\Client\Configuration::getDefaultConfiguration(); $config->setAccessToken($accessToken); $config->setHost('https://www.{domain}/api/v3/integration'); $apiInstance = new DocPlanner\Client\Api\DoctorsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $facility_id = 56; // int | ID of the Facility $with = array(\DocPlanner\Client\Model\DoctorsScopes::SPECIALIZATIONS); // string[] | try { $result = $apiInstance->getDoctors($facility_id, $with); print_r($result); } catch (Exception $e) { echo 'Exception when calling DoctorsApi->getDoctors: ', $e->getMessage(), PHP_EOL; } // Configure access token for authorization $config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken($accessToken); $apiInstance = new DocPlanner\Client\Api\AddressesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $facility_id = 56; // int | ID of the Facility $doctor_id = 56; // int | ID of a doctor in a facility try { $result = $apiInstance->getAddresses($facility_id, $doctor_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling AddressesApi->getAddresses: ', $e->getMessage(), PHP_EOL; } ?>
授权
要获取对 API 的访问权限,您需要使用您的客户端凭据(client_id
和 client_secret
)向 https://www.{domain}/oauth/v2/token
发送请求以获取访问令牌。然后,它可以注入到 Configuration
中,该配置用于实例化 API 客户端。整个授权过程基于 OAuth2 协议,其中 grant_type = client_credentials
和 scope = integration
。获取的令牌有效期为 24 小时,因此将其缓存一段时间是好的做法。
###示例
//Get OAuth2 access token $authorization = new DocPlanner\Client\Authorization('https://www.{domain}/oauth/v2/token'); $accessToken = $authorization->getAccessToken('YOUR_CLIENT_ID', 'YOUR_CLIENT_SECRET'); // Configure access token for authorization $config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken($accessToken); $apiInstance = new DocPlanner\Client\Api\AddressesApi(null, $config);
API 端点文档
所有 URI 都是相对于 https://www.{domain}/api/v3/integration
模型文档
- AddAddressInsuranceProviderRequest
- AddAddressServiceRequest
- AddCalendarBreakRequest
- Address
- AddressBookingExtraFields
- AddressInsuranceProvider
- AddressInsuranceProviders
- AddressScopes
- AddressService
- AddressServiceNotification
- AddressServices
- Addresses
- AddressesScopes
- BookSlotRequest
- Booking
- BookingCanceledNotification
- BookingConfirmedNotification
- BookingMovedNotification
- BookingMovedNotificationData
- BookingMovingNotification
- BookingMovingNotificationData
- BookingNotification
- BookingPatient
- Bookings
- BookingsScopes
- BreakCreatedNotification
- BreakCreatedNotificationData
- BreakMovedNotification
- BreakNotification
- BreakRemovedNotification
- CalendarBreak
- CalendarBreaks
- CancelBookingRequest
- Doctor
- DoctorScopes
- Doctors
- DoctorsScopes
- Error
- Facilities
- Facility
- FacilityScopes
- Insurance
- InsuranceNotification
- InsurancePlan
- InsurancePlans
- InsuranceProvider
- InsuranceProviders
- LicenseNumber
- LicenseNumbers
- MoveBookingRequest
- MoveCalendarBreakRequest
- Notification
- OpinionRequest
- Patient
- PresenceMarkedNotification
- PresenceMarkedNotificationData
- PullMultipleNotificationsResponse
- ReplaceSlotsRequest
- ReplaceSlotsRequestAddressServices
- ReplaceSlotsRequestSlots
- Service
- Services
- ServicesScopes
- Slot
- SlotBookedNotification
- SlotBookedNotificationData
- SlotBookingNotification
- SlotBookingNotificationData
- Slots
- SlotsScopes
- Specialization
- Specializations
- UpdateAddressServiceRequest
- UpdateOrCreateAddressInsuranceProviderRequest
- UpdateOrCreateAddressInsuranceProviderRequestInsurancePlans
- VisitBookingRequestNotification