{"id":20505596,"url":"https://github.com/openbankproject/api-explorer","last_synced_at":"2025-04-13T21:07:37.025Z","repository":{"id":4952800,"uuid":"44889005","full_name":"OpenBankProject/API-Explorer","owner":"OpenBankProject","description":"API Explorer for OBP API. A Scala / Liftweb application that consumes the OBP-API resource documentation so that developers can browse and interact with the OBP REST API enpoints.  ","archived":false,"fork":false,"pushed_at":"2024-05-14T09:20:30.000Z","size":6745,"stargazers_count":31,"open_issues_count":11,"forks_count":56,"subscribers_count":11,"default_branch":"develop","last_synced_at":"2025-04-13T21:07:31.459Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Scala","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/OpenBankProject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2015-10-24T23:28:49.000Z","updated_at":"2025-03-04T23:16:21.000Z","dependencies_parsed_at":"2023-07-06T19:33:38.455Z","dependency_job_id":"0dccca91-86bb-477a-b507-2cbaf2409f49","html_url":"https://github.com/OpenBankProject/API-Explorer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenBankProject","download_url":"https://codeload.github.com/OpenBankProject/API-Explorer/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248782270,"owners_count":21160717,"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","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":[],"created_at":"2024-11-15T19:48:16.895Z","updated_at":"2025-04-13T21:07:37.005Z","avatar_url":"https://github.com/OpenBankProject.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"Welcome to the OBP API Explorer\n===============================\n\n# ABOUT\n\nThis application is used to explore the OBP API and interact with the data and services in the context of the logged in user.\n\n\n\n# LICENSE\n\nThis project is licensed under the AGPL V3 (see NOTICE) and a commercial license from TESOBE.\n\n# SETUP\n\nThe project is using sbt or Maven 3 as a build tool.\nSee build.scala or pom.xml respectively for the dependencies.\n\n----\n\nTo compile and run jetty, cd into the root directory (where this file is) and run:\n\n$ sbt\n...\n\u003e compile\n\u003e ~;container:start; container:reload /\n\n(Note that you first have to start sbt and then on its console start jetty with the container:start task, otherwise it will exit immediately. More here: https://github.com/siasia/xsbt-web-plugin/wiki)\n\nIn OS X, sbt can be installed with $ sudo port install sbt\n\n----\n\n\nAlternatively, maven can also be used:\n\n`mvn jetty:run`\n\nIn case you want to specify and port as well use next command `mvn -Djetty.port=8082 jetty:run`\n\n\nNote: You may need to add the pluginGroup to the $HOME/.m2/settings.xml\n\n\u003csettings xmlns=\"http://maven.apache.org/SETTINGS/1.0.0\"\n  xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n  xsi:schemaLocation=\"http://maven.apache.org/SETTINGS/1.0.0\n                      http://maven.apache.org/xsd/settings-1.0.0.xsd\"\u003e\n  ...\n  \u003cpluginGroups\u003e\n    \u003cpluginGroup\u003eorg.mortbay.jetty\u003c/pluginGroup\u003e\n  \u003c/pluginGroups\u003e\n  ...\n\u003c/settings\u003e\n\n---\n\n## To run with IntelliJ IDEA\n\n* Make sure you have the IntelliJ Scala plugin installed.\n\n* Create a new folder e.g. OpenBankProject and cd there\n\n* git clone https://github.com/OpenBankProject/API-Explorer.git\n\n* In IntelliJ IDEA do File -\u003e New -\u003e Project from existing sources, navigate to the folder and select pom.xml\n\n* Alternatively you can do File -\u003e New -\u003e Project from VCS and checkout the project directly from github.\n\n* Alternatively you can do File -\u003e Open Folder and select the folder that contains pom.xml *This is the currently recommended method*\n\n* When / if prompted for SDK, choose Java 1.8 (and Scala 2.11) otherwise keep the defaults. Use the Maven options. Do not change the project name etc.\n\n* If you see a message about an unmanaged pom.xml, click the option to let Maven manage it.\n\n* Navigate to test/scala/RunWebApp. You may see a Setup Scala SDK link. Click this and check Scala 2.11.8 or so.\n\n* In src/main/resources/props create a \\\u003cyourloginname\\\u003e.props (or default.props) for development. For localhost set api_hostname=http://127.0.0.1:8080, base_url=http://localhost:8082, dev.port=8082 and oauth keys (i.e. obp_consumer_key and obp_consumer_secret) obtained from the api (at /consumer-registration) to run [OBP-API](https://github.com/OpenBankProject/OBP-API) in your local environment.\n\n* Now **Rebuild** the project so everything is compiled. At this point you may need to select the SDK, see above.\n\n* Once you have rebuilt the project without compile errors, you should be able to RunWebApp in test/scala\n\n* Run RunWebApp by right clicking on it or selecting Run. The built in jetty server should start on localhost:8082\n\n* Browse to localhost:8082 but don't try anything else there yet.\n\n## Ubuntu\n\nIf you use Ubuntu (or a derivate) and encrypted home directories (e.g. you have ~/.Private), you might run into the following error when the project is built:\n\n    uncaught exception during compilation: java.io.IOException\n    [ERROR] File name too long\n    [ERROR] two errors found\n    [DEBUG] Compilation failed (CompilerInterface)\n\nThe current workaround is to move the project directory onto a different partition, e.g. under /opt/ .\n\n# PROPS FILE\n\nThere is a props file template provided at src/main/resources/props/sample.props.template. It needs to be renamed and modified or just copy and paste a new in order for the application to work.\n\n1. Renaming:\n\nThe sample.props.template file must be renamed for Lift to find it (https://www.assembla.com/wiki/show/liftweb/Properties). Renaming it to default.props\nshould be the easiest way to get started.\n\n\n*base_url*\n\nThe base_url is used to calculate the callback url to give to the Open Bank Project API server. This should just be the\nbase url used to access the API Explorer. So if you're running a copy of the API Explorer at\napi-explorer.example.com over https, on the standard port, it would be \"https://api-explorer.example.com\".\nAn example value for local development could be: http://127.0.0.1:8082 (8082 is the default Lift development port)\n\n*api_hostname*\n\nThe api_hostname should be the base url of the Open Bank Project API. For example, https://api.openbankproject.com/api amd for local development api_hostname should be http://127.0.0.1:8080 in props file. \n\n*obp_consumer_key*\n*obp_secret_key*\n\nThe keys are obtained by registering as a developer on the Open Bank Project API server located at \"api_hostname\".\n\n\nAll in all, a props file could look something like:\n\napi_hostname=https://api.openbankproject.com/api \n\n### OR \nThe base url of the api to use for local: \napi_hostname=http://127.0.0.1:8080\n\nobp_consumer_key=uodsifnodsfifdsliufdsliufdsfdsfsdfsx \\\nobp_secret_key=iuesbfiyvglxzgifg7eisgei7fglesfi \\\nbase_url=http://localhost:8082\n\n## The list of Endpoints that API Explorer needs to function\n\n### Before Login:\nGet API Info (root): /obp/v4.0.0/root \\\nGet Banks: /obp/v3.1.0/banks \\\nGet Resource Docs: /obp/v4.0.0/resource-docs/OBPv5.1.0/obp \\\nGet Glossary of the API: /obp/v3.0.0/api/glossary \\\nGet all Authentication Type Validations - public: /obp/v4.0.0/endpoints/authentication-type-validations \\\nGet all JSON Schema Validations: /obp/v4.0.0/endpoints/json-schema-validations \\\nGet Message Docs: /obp/v2.2.0/message-docs/CONNECTOR\n\n### After Login\nOauth1.0: /oauth/initiate \\\nOauth1.0: /oauth/token\n\nGet private accounts at all banks (Authenticated access): /obp/v1.2.1/accounts/private \\\nGet Entitlements for the current User: /obp/v3.0.0/my/entitlements \\\nGet Entitlement Requests for the current User: /obp/v3.0.0/my/entitlement-requests \\\nGet My Spaces: /obp/v4.0.0/my/spaces \\\nGet Api Collection Endpoints: /obp/v4.0.0/api-collections//api-collection-endpoints \\\nGet My Api Collection Endpoints: /obp/v4.0.0/my/api-collections/Favourites/api-collection-endpoints \\\nGet My Api Collections: /obp/v4.0.0/my/api-collections \\\nGet User (Current): /obp/v3.0.0/users/current","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fapi-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbankproject%2Fapi-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fapi-explorer/lists"}