Download the PHP package masmerise/scrada-php-sdk without Composer
On this page you can find all versions of the php package masmerise/scrada-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download masmerise/scrada-php-sdk
More information about masmerise/scrada-php-sdk
Files in masmerise/scrada-php-sdk
Package scrada-php-sdk
Short Description An unofficial PHP SDK for accessing Scrada's API.
License MIT
Homepage https://github.com/masmerise/scrada-php-sdk
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package scrada-php-sdk
Scrada PHP SDK
This SDK provides convenient, fully-typed access to Scrada's API.
Installation
You can install the package via composer:
Adapters
You may also use one of the available adapters instead:
Getting started
You can always refer to the documentation to examine the various resources that are available.
Setup
Data retrieval
Resource update
Failures (exception handling)
The SDK uses exceptions as its medium to communicate failures.
API failures
API interaction failures, i.e. exceptions of type ValidationException,
always expose a special ScradaError object that contains the API's reasons for rejection:
Rate limiting
The SDK is equipped with out-of-the-box capabilities to deal with Scrada's request constraints.
In order to make use of this, you will have to provide a PSR-16 compatible cache store so the SDK
can keep track of its current state.
Chances are that you are going to use this SDK in conjunction with a popular web framework, and most of them already have a PSR-16 compatible implementation of a cache store available:
Localization
You can use one of the available methods to change the API's language:
Dutch
English (default)
French
Environment
You can use one of the available methods to change the API's environment:
Production (default)
Test
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the default retry limit (2).
A request is deemed retriable when any of the following HTTP status codes is returned:
Timeouts
The SDK defaults to a 10 second timeout.
Implementation progress
| Resource | Action |
|---|---|
| Cash book | Get all cash books |
| Update cash book | |
| Company | Get company |
| Update company |
While the SDK is battle-tested and production-ready, only a handful of API interactions have been implemented thus far. Please bear in mind this is an unofficial SDK, so we have to prioritize available resources at this time.
However, always feel free to submit a feature or pull request!
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Muhammed Sari
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of scrada-php-sdk with dependencies
psr/simple-cache Version ^3.0
saloonphp/rate-limit-plugin Version ^2.0
saloonphp/saloon Version ^4.0
webmozart/assert Version ^2.0