emnify / emnify-sdk
Supply your swarm of IoT devices with cloud connectivity by emnify. Automate your routines with this SDK for PHP.
0.0.2
2024-07-09 19:11 UTC
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.7
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-11-02 06:23:57 UTC
README
Rest API resources of the emnify System.
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"require": {
"emnify/emnify-sdk": "*@dev"
}
}
Then run composer install
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Swagger\Client\Api\ApplicationTokensApi( // 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 ); $body = new \Swagger\Client\Model\ApplicationToken(); // \Swagger\Client\Model\ApplicationToken | $app_token_id = 1.2; // float | application token ID try { $apiInstance->applicationTokenByIdPatch($body, $app_token_id); } catch (Exception $e) { echo 'Exception when calling ApplicationTokensApi->applicationTokenByIdPatch: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Swagger\Client\Api\ApplicationTokensApi( // 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 ); try { $result = $apiInstance->applicationTokenGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApplicationTokensApi->applicationTokenGet: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Swagger\Client\Api\ApplicationTokensApi( // 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 ); $body = new \Swagger\Client\Model\CreateApplicationTokenrequest(); // \Swagger\Client\Model\CreateApplicationTokenrequest | try { $result = $apiInstance->applicationTokenPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApplicationTokensApi->applicationTokenPost: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://cdn.emnify.net
Documentation For Models
- AccountActivationrequest
- ActionOnExhaustion
- ActivateBatch
- ActivateMFAKeyRequest
- Apiv1cncbreakoutStatus
- Apiv1eventEventSeverity
- Apiv1eventEventSource
- Apiv1eventEventType
- Apiv1eventOrganisation
- Apiv1eventUser
- Apiv1organisationorgIdOrMyinclusiveVolumeactiveCurrency
- Apiv1organisationorgIdOrMyinclusiveVolumeactiveTariff
- Apiv1organisationorgIdOrMyinclusiveVolumeactiveTariffRatezone
- Apiv1organisationorgIdtariffPlanServiceLevel
- Apiv1organisationorgIdtariffPlanTariffPlan
- Apiv1organisationorgIdtariffPlanTariffPlanCurrency
- Apiv1organisationorgIdtariffPlanTariffPlanPrice
- Apiv1organisationorgIdtariffPlanTariffPlanServiceLevel
- Apiv1organisationorgIdtariffPlanTariffPlanStatus
- Apiv1organisationorgIdtariffPlanTariffPlanVisibility
- Apiv1serviceserviceIdtrafficLimitPeriod
- Apiv1simCustomerOrg
- Apiv1simsimIdstatsLastMonth
- Apiv1simsimIdstatsLastMonthData
- Apiv1tariffProfileTariff
- Apiv1tariffProfileTariffCurrency
- Apiv1userStatus
- Apiv1usermfakeyIdStatus
- Apiv2dataStreamDestination
- Apiv2dataStreamFilters
- Apiv2dataStreamdataStreamIdStatus
- ApplicationToken
- Authentication
- AuthenticationResponse
- ChangePassword422Error
- ChangePasswordrequest
- ChangeQuota422Error
- CloudConnectBreakoutType
- Country
- CreateApplicationTokenrequest
- CreateApplicationTokenresponse
- CreateCloudConnectTGWRequest
- CreateCloudConnectVPNRequest
- CreateCloudConnectVPNRequest1
- CreateMFAKeyResponse
- CreateTariffProfilerequest
- CreateUserrequest
- CreateaDNSentryrequest
- CreateaServiceProfilerequest
- Currency
- DataStreamDataStreamIdBody
- ESIMInstallationCodeInJSONFormat
- Endpoint
- Endpoint1
- Endpoint2
- EndpointQuota
- EndpointQuota1
- EndpointRuntimeData
- Event
- FormFactor
- GetHourlyOrganisationStatsResponse
- GetHourlyOrganisationStatsResponseData
- GetHourlyOrganisationStatsResponseSms
- GetMonthlyOrganisationStatsResponse
- GetMonthlyOrganisationStatsResponseInclusiveVolume
- GetMonthlyOrganisationStatsResponsePrepaidBalance
- GetMonthlyOrganisationStatsResponseSim
- GetOrganisationActiveTariffPlanResponse
- GetOrganisationActiveTariffPlanResponseAppliedPrice
- GetOrganisationActiveTariffPlanResponseAppliedPriceSimActivatedRate
- GetOrganisationActiveTariffPlanResponseTariffPlan
- GetOrganisationActiveTariffPlanResponseTariffPlanPrice
- GetOrganisationActiveTariffPlanResponseTariffPlanPriceSimActivatedRate
- GetOrganisationActiveTariffPlanResponseTariffPlanRuntime
- GetdetailsofSMSresponse
- HasId
- InclusiveVolumeInclusiveVolumeIdBody
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20011
- InlineResponse20012
- InlineResponse20013
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- InlineResponse2008
- InlineResponse2009
- InlineResponse201
- InlineResponse404
- InlineResponse422
- ListofAllAvailableSIMStatusesresponse
- ListofApplicationTokensresponse
- ListofSMSresponse
- Listoftrusteddevicesresponse
- MFAKeyStatusLookupresponse
- MFAKeyTypeLookupresponse
- Model40xResponse
- OneOfapiv1organisationorgIdtariffPlanTariffPlanPriceSimActivatedRateItems
- OneOfapiv2dataStreamDestinationCredentials
- OrganisationDailyTrafficObject
- OrganisationDailyTrafficObjectTrafficType
- OrganisationTrafficStatisticsMonthObject
- OrganisationTrafficStatisticsObject
- PatchTariffProfilerequest
- QuotaStatus
- RATType
- ResendActivationMailrequest
- ResponseOfActivatableSIMBatch
- ResponseSchemaForSIMStatistics
- RetrieveAvailableAddressSpacesresponse
- RetrieveAvailableBreakoutRegionsresponse
- RetrieveAvailableCountriesresponse
- RetrieveAvailableCurrenciesresponse
- RetrieveAvailableDataBlocksizesresponse
- RetrieveAvailableDataThrottlesresponse
- RetrieveAvailableESMEInterfaceTypesresponse
- RetrieveAvailableServicesresponse
- RetrieveAvailableUserStatusesresponse
- RetrieveConnectivityInformationresponse
- RetrieveCoverageresponse
- RetrieveEndpointConnectivityStatusresponse
- RetrieveEndpointStatisticsresponse
- RetrieveEventTypesresponse
- RetrieveEventsresponse
- RetrieveEventsresponse4
- RetrieveOperatorBlacklistresponse
- RetrieveOrganisationStatusesresponse
- RetrievePrepaidBalanceresponse
- RetrieveServiceProfileListresponse
- RetrieveaSingleServiceProfileresponse
- RetrieveavailableTrafficLimitsresponse
- RetrieveownIPAddressSpacesresponse
- RetrievetheUserresponse
- SMSQuota
- ServiceProfile
- Sim
- SimEntry
- SimEntry1
- SimManufacturer
- SimModel
- StartingaUSSDDialogrequest
- StartingaUSSDDialogresponse
- Status
- SubmitMTSMSrequest
- SuccessfulBatchActivation
- TariffProfile
- TariffProfile1
- TariffProfile2
- TariffProfileInclusiveVolume
- TariffProfileInclusiveVolumeCurrency
- TariffProfileInclusiveVolumeRatezone
- UpdateEndpoint
- UpdateEndpointConnectivityByIdRequest
- UpdatePrepaidBalanceresponse
- UpdateSIM
- UpdateServiceProfile
- UpdateTariffRequest
- UpdateUserrequest
- User
- UserByIdV2CreateSupportTokenRequest
- UserByIdV2CreateSupportTokenRequest1
- UserMfaBody
- V1ApiSecretBody
- V2DataStreamBody
Documentation For Authorization
bearerAuth
- Type: HTTP bearer authentication