https://github.com/hslatman/ros-web-api
A Realm Object Server Web API Client written in PHP
https://github.com/hslatman/ros-web-api
Last synced: 3 months ago
JSON representation
A Realm Object Server Web API Client written in PHP
- Host: GitHub
- URL: https://github.com/hslatman/ros-web-api
- Owner: hslatman
- Created: 2017-10-16T17:39:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-18T21:14:19.000Z (over 7 years ago)
- Last Synced: 2025-01-25T23:34:16.058Z (4 months ago)
- Language: PHP
- Size: 17.6 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ros-web-api
A Realm Object Server Web API Client written in PHP.
## Installation
This is still a work in progress!
## Usage
Currently only GET type requests and User creation are supported. See _tests/test.php_ for more examples.
```php
'http://localhost',
'port' => 9080,
'username' => '[email protected]',
'password' => 'some_random_password'
];
$client = new ROSClient($config);
$client->authenticate();
$realms = $client->getRealms();
```
## Notes
This implementation only allows password authentication at this time.
The current version was tested against Realm Object Server Professional Edition v1.8.3.
The team at Realm is working on creating a new version of the Realm Object Server which may provide more useful management functions out of the box.
## TODO
* Implement POST calls, e.g. for creating new Users
* Improve error handling
* Improve authentication handling
* Improve refresh token handling
* Add test framework
* Provide entities for result objects
* Implement the API calls for logs
* (Optional) handle JSON paging using limit and offset
* Improve (API) documentation