Download the PHP package onecommunity/client without Composer
On this page you can find all versions of the php package onecommunity/client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download onecommunity/client
More information about onecommunity/client
Files in onecommunity/client
Package client
Short Description PHP client to access the One Community API.
License MIT
Homepage https://github.com/emolifeconnect/onecommunity-php
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 client
One Community
An easy-to-use PHP client to access the One Community API.
Installation
Using Composer:
composer require onecommunity/client
Contact us with your public key to receive your API key.
Usage
Initializing the Client
Sending Requests
See the Examples directory for working examples.
UserRequest
Returns the User object of the authenticated user. Great for testing.
SendTransactionalMailRequest
Responses
The following HTTP status codes are used:
| HTTP Status Code | Description |
|---|---|
| 200 OK | Everything is OK, the body contains the payload. |
| 400 Bad Request | Indicates an authentication error. |
| 404 Not Found | Some ID refers to an unknown model (e.g., unknown account or mail). |
| 422 Unprocessable Entity | Validation errors. |
| 429 Too Many Requests | You cannot send more than 60 requests per minute. |
If anything unexpected occurs a OneCommunity\Exceptions\RequestException is thrown (e.g., if the API does not return a valid JSON response).
All responses (except 200 OK) contain a message attribute, explaining what went wrong. Furthermore, 400 Bad Requests responses contain a code attribute which can contain one of the following values:
| code | message |
|---|---|
| 100 | Invalid API key |
| 101 | Could not decode Bearer token |
| 102 | No API key found on request |
| 103 | No Bearer token found on request |
| 104 | Token could not be verified |
| 201 | Client not found |
| 202 | User not found or not accessible by this API Client |
| 501 | No access to this project or invalid project |
| 502 | No access from this IP |
The validation errors of a 422 Unprocessable Entity response are structured as follows:
Security
The API is based on JWT API, an efficient and secure machine-to-machine API using JSON Web Tokens and asymmetric request signing. Advantages of this approach include:
- Requests and responses are sent over a secure channel.
- Requests can only be signed by the API consumer (providing non-repudiation).
- Requests are only valid for a short time (avoiding replay attacks).
Due to the asymmetric nature of this protocol, a public/private key pair needs to be generated (RSA 2048 bit). The key pair can be generated by issuing the following commands. Please send your public key (public_rsa.pem) to us and keep your private key safe.
