Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hivesolutions/omni-api
Simple REST API wrapper for the Omni infra-structure
https://github.com/hivesolutions/omni-api
api client omni python
Last synced: about 11 hours ago
JSON representation
Simple REST API wrapper for the Omni infra-structure
- Host: GitHub
- URL: https://github.com/hivesolutions/omni-api
- Owner: hivesolutions
- Created: 2013-12-09T15:20:10.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T05:57:51.000Z (7 months ago)
- Last Synced: 2024-11-07T06:43:30.582Z (9 days ago)
- Topics: api, client, omni, python
- Language: Python
- Homepage: http://omni-api.hive.pt
- Size: 339 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# [Omni API](http://omni-api.hive.pt)
Simple REST API wrapper for the Omni infra-structure.
## Configuration
| Name | Type | Description |
| --------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------ |
| **OMNI_BASE_URL** | `str` | The base URL that is going to be used for API connections (defaults to `http://localhost:8080/mvc/`). |
| **OMNI_OPEN_URL** | `str` | The open URL for the Omni connection (defaults to `OMNI_BASE_URL`). |
| **OMNI_PREFIX** | `str` | The default prefix to be used for API requests (defaults to `adm/`). |
| **OMNI_ID** | `str` | The client id to be used for API connections (defaults to `None`). |
| **OMNI_SECRET** | `str` | The secret key to be used for API connections (defaults to `None`). |
| **OMNI_REDIRECT_URL** | `str` | The URL to be used for redirection OAuth based workflow (defaults to `base,base.user,base.admin,foundation.store.list`). |
| **OMNI_USERNAME** | `str` | The username to be used on direct workflow (defaults to `None`). |
| **OMNI_PASSWORD** | `str` | The password to be used on direct workflow (defaults to `None`). |
## Usage
Typical usage of the Omni client implies the providing of the username and the
password inside the target omni instance (Direct Mode).
```python
api = omni.Api(
base_url = "http://frontdoorhq.com",
username = "YOUR_USERNAME",
password = "YOUR_PASSWORD"
)
```
Alternatively it's possible to use the api throught an OAuth base approach using
the provided client id and secret values.
```python
api = omni.Api(
base_url = "http://frontdoorhq.com",
client_id = "YOUR_OAUTH_ID",
client_secret = "YOUR_OAUTH_SECRET"
)
```
For these type of handling the `OAuthAccessError` exception must be handled and then
the user must be redirect to the url provided by `api.oauth_autorize` method call.
Running then the `api.oauth_access` call with the returned `code` from the server side
that should be used to redeem the `access_token` required for session authentication.
## Examples
Examples are located [here](src/examples).
## License
Omni API is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
## Build Automation
[](https://travis-ci.com/github/hivesolutions/omni-api)
[](https://github.com/hivesolutions/omni-api/actions)
[](https://coveralls.io/r/hivesolutions/omni-api?branch=master)
[](https://pypi.python.org/pypi/omni-api)
[](https://www.apache.org/licenses/)