{"id":20541735,"url":"https://github.com/hivesolutions/omni-api","last_synced_at":"2025-12-17T03:49:26.107Z","repository":{"id":12397799,"uuid":"15050762","full_name":"hivesolutions/omni-api","owner":"hivesolutions","description":"Simple REST API wrapper for the Omni infra-structure","archived":false,"fork":false,"pushed_at":"2025-11-22T19:07:08.000Z","size":405,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-22T21:06:53.057Z","etag":null,"topics":["api","client","omni","python"],"latest_commit_sha":null,"homepage":"http://omni-api.hive.pt","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hivesolutions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-12-09T15:20:10.000Z","updated_at":"2025-11-22T19:07:12.000Z","dependencies_parsed_at":"2024-04-26T18:28:15.793Z","dependency_job_id":"b5d646d1-bad0-4c1a-b605-a0c1b5c94144","html_url":"https://github.com/hivesolutions/omni-api","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/hivesolutions/omni-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivesolutions%2Fomni-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivesolutions%2Fomni-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivesolutions%2Fomni-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivesolutions%2Fomni-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hivesolutions","download_url":"https://codeload.github.com/hivesolutions/omni-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivesolutions%2Fomni-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27776608,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-17T02:00:08.291Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","client","omni","python"],"created_at":"2024-11-16T01:25:46.917Z","updated_at":"2025-12-17T03:49:26.095Z","avatar_url":"https://github.com/hivesolutions.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Omni API](http://omni-api.hive.pt)\n\nSimple REST API wrapper for the Omni infra-structure.\n\n## Configuration\n\n| Name                  | Type  | Description                                                                                                              |\n| --------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------ |\n| **OMNI_BASE_URL**     | `str` | The base URL that is going to be used for API connections (defaults to `http://localhost:8080/mvc/`).                    |\n| **OMNI_OPEN_URL**     | `str` | The open URL for the Omni connection (defaults to `OMNI_BASE_URL`).                                                      |\n| **OMNI_PREFIX**       | `str` | The default prefix to be used for API requests (defaults to `adm/`).                                                     |\n| **OMNI_ID**           | `str` | The client id to be used for API connections (defaults to `None`).                                                       |\n| **OMNI_SECRET**       | `str` | The secret key to be used for API connections (defaults to `None`).                                                      |\n| **OMNI_REDIRECT_URL** | `str` | The URL to be used for redirection OAuth based workflow (defaults to `base,base.user,base.admin,foundation.store.list`). |\n| **OMNI_USERNAME**     | `str` | The username to be used on direct workflow (defaults to `None`).                                                         |\n| **OMNI_PASSWORD**     | `str` | The password to be used on direct workflow (defaults to `None`).                                                         |\n\n## Usage\n\nTypical usage of the Omni client implies the providing of the username and the\npassword inside the target omni instance (Direct Mode).\n\n```python\napi = omni.Api(\n    base_url = \"http://frontdoorhq.com\",\n    username = \"YOUR_USERNAME\",\n    password = \"YOUR_PASSWORD\"\n)\n```\n\nAlternatively it's possible to use the api throught an OAuth base approach using\nthe provided client id and secret values.\n\n```python\napi = omni.Api(\n    base_url = \"http://frontdoorhq.com\",\n    client_id = \"YOUR_OAUTH_ID\",\n    client_secret = \"YOUR_OAUTH_SECRET\"\n)\n```\n\nFor these type of handling the `OAuthAccessError` exception must be handled and then\nthe user must be redirect to the url provided by `api.oauth_autorize` method call.\n\nRunning then the `api.oauth_access` call with the returned `code` from the server side\nthat should be used to redeem the `access_token` required for session authentication.\n\n## Examples\n\nExamples are located [here](src/examples).\n\n## License\n\nOmni API is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).\n\n## Build Automation\n\n[![Build Status](https://github.com/hivesolutions/omni-api/workflows/Main%20Workflow/badge.svg)](https://github.com/hivesolutions/omni-api/actions)\n[![Coverage Status](https://coveralls.io/repos/hivesolutions/omni-api/badge.svg?branch=master)](https://coveralls.io/r/hivesolutions/omni-api?branch=master)\n[![PyPi Status](https://img.shields.io/pypi/v/omni-api.svg)](https://pypi.python.org/pypi/omni-api)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhivesolutions%2Fomni-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhivesolutions%2Fomni-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhivesolutions%2Fomni-api/lists"}