netzfabrik / netzfabrik-php-api
PHP SDK for NETZFABRIK API
dev-main
2023-06-12 08:03 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
This package is not auto-updated.
Last update: 2024-12-24 13:46:15 UTC
README
PHP client library for the NETZFABRIK API
For more information, please visit https://www.netzfabrik.com.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/NETZFABRIKCOM/netzfabrik-php-api.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/netzfabrik-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: JWT $config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = NETZFABRIK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new NETZFABRIK\Api\AccountApi( // 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 ); $id = 'id_example'; // string | Account identifier try { $result = $apiInstance->getAccount($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to http://localhost
Models
- AccessKey
- AccessKeyBucket
- AccountAccountRead
- AccountAccountReadCustomer
- AccountUserReadUserMeReadAccountMeCustomerMe
- ApiToken
- ApiTokenApiTokenCreatedResponse
- ApiTokenApiTokenReadTimestampableCreatedAtReadTimestampableUpdatedAtRead
- ApiTokenCreateApiTokenRequest
- ApplicationApplicationListServiceLevelAgreementReadApplicationTypeListCloudServerListZoneRead
- ApplicationApplicationListServiceLevelAgreementReadApplicationTypeListCloudServerListZoneReadServiceLevelAgreement
- ApplicationApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneRead
- ApplicationApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneReadCloudServer
- ApplicationApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneReadServiceLevelAgreement
- ApplicationTypeApplicationListServiceLevelAgreementReadApplicationTypeListCloudServerListZoneRead
- ApplicationTypeApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneRead
- Bill
- BillBillGraphResponse
- BillHistory
- Bucket
- Colocation
- ColocationInterconnection
- ColocationPowerFeed
- Customer
- CustomerAccountRead
- CustomerCreateCustomerRequest
- CustomerUserReadUserMeReadAccountMeCustomerMe
- DnssecInfoKeyZoneDnssec
- DomainCancelRequest
- DomainCheckDomainAvailabilityRequestDomainCheck
- DomainDomainAvailabilityResponseDomainCheck
- DomainDomainList
- DomainDomainReadHandleReadNameserverRead
- DomainDomainReadHandleReadNameserverReadAdminHandle
- DomainRegisterDomainRequest
- DomainRegistrar
- DomainRegistrarHandle
- DomainResellerDomainResellerBillingDataResponse
- DomainResellerDomainResellerRead
- DomainTransitRequest
- Handle
- HandleCreateHandleRequestHandleWrite
- HandleDomainReadHandleReadNameserverRead
- HandleHandleRead
- Interconnection
- InvoiceInvoiceList
- InvoiceInvoiceRead
- IpAddress
- IpAddressApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneRead
- IpAddressCloudServerListRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtRead
- IpAddressCloudServerReadServiceLevelAgreementReadRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadVirtualMachineTaskRead
- IpAddressPool
- IpAddressPoolIpAddressPoolCreate
- IpAddressWebspaceRead
- LoginActivity
- LoginCheckPost200Response
- LoginCheckPostRequest
- MessageTicketRead
- MessageTicketReadMaintenanceRead
- NameserverDomainReadHandleReadNameserverRead
- NetworkAttachNetworkToServerRequest
- PaymentMethodInvoiceRead
- PhoneNumber
- PleskHostWebspaceRead
- PowerFeed
- Rack
- Region
- RegionCloudServerListRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtRead
- RegionCloudServerReadServiceLevelAgreementReadRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadVirtualMachineTaskRead
- RrdDataItemRrdDataRead
- ServiceLevelAgreementApplicationListServiceLevelAgreementReadApplicationTypeListCloudServerListZoneRead
- ServiceLevelAgreementApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneRead
- ServiceLevelAgreementCloudServerReadServiceLevelAgreementReadRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadVirtualMachineTaskRead
- TicketCreateTicketRequestTicketCreate
- TicketMessageMessageCreate
- TicketReplyTicketRequestMessageCreate
- TicketTicketList
- TicketTicketRead
- TicketTicketReadMaintenanceRead
- User
- UserChangePasswordRequestDefault
- UserCompleteUserRequestUserComplete
- UserCustomer
- UserPasswordRecoveryTestResponse
- UserRegisterUserRequestUserRegister
- UserRequestPasswordRecoveryRequestDefault
- UserSetDefaultCustomerRequestDefault
- UserUserMeResponseUserReadUserMeReadAccountMeCustomerMe
- UserUserMeResponseUserReadUserMeReadAccountMeCustomerMeAccount
- UserUserMeResponseUserReadUserMeReadAccountMeCustomerMeCustomer
- VLAN
- VirtualMachineApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneRead
- VirtualMachineApplicationReadServiceLevelAgreementReadApplicationTypeReadCloudServerReadZoneReadIpV4
- VirtualMachineCloudServerListRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtRead
- VirtualMachineCloudServerListRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadIpV4
- VirtualMachineCloudServerReadServiceLevelAgreementReadRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadVirtualMachineTaskRead
- VirtualMachineCloudServerReadServiceLevelAgreementReadRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadVirtualMachineTaskReadIpV4
- VirtualMachineCloudServerReadServiceLevelAgreementReadRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadVirtualMachineTaskReadServiceLevelAgreement
- VirtualMachineCloudServerStatisticsResponseRrdDataRead
- VirtualMachineTaskCloudServerReadServiceLevelAgreementReadRegionReadTimestampableCreatedAtReadTimestampableUpdatedAtReadVirtualMachineTaskRead
- WebspaceCreateWebspaceRequestWebspaceCreate
- WebspacePlan
- WebspacePlanWebspaceRead
- WebspaceWebspaceLoginSessionResponseWebspaceLoginSession
- WebspaceWebspaceRead
- WebspaceWebspaceReadIpAddressV4
- WebspaceWebspaceReadIpAddressV6
- WebspaceWebspaceReadPleskHost
- ZoneDnssecInfoZoneDnssec
- ZoneNameserverZoneList
- ZoneNameserverZoneListZoneRead
- ZoneNameserverZoneRead
- ZoneNameserverZoneReadZoneListZoneRecordRead
- ZoneNameserverZoneReadZoneRecordRead
- ZoneRecord
- ZoneRecordInputZoneCreateZoneRecordCreate
- ZoneRecordZoneReadZoneListZoneRecordRead
- ZoneRecordZoneReadZoneRecordRead
- ZoneRecordZoneRecordInputZoneRecordCreate
- ZoneRecordZoneRecordRead
- ZoneRecordZoneRecordUpdate
- ZoneRecordZoneUpdateZoneRecordUpdate
- ZoneZoneInputZoneCreateZoneRecordCreate
- ZoneZoneList
- ZoneZoneListZoneRead
- ZoneZoneRead
- ZoneZoneReadZoneListZoneRecordRead
- ZoneZoneReadZoneRecordRead
- ZoneZoneUpdateZoneRecordUpdate
Authorization
Authentication schemes defined for the API:
JWT
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
0.0.0
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen