{"id":20505595,"url":"https://github.com/openbankproject/api-explorer-ii","last_synced_at":"2025-10-04T16:41:53.818Z","repository":{"id":177194842,"uuid":"594111036","full_name":"OpenBankProject/API-Explorer-II","owner":"OpenBankProject","description":"API Explorer II","archived":false,"fork":false,"pushed_at":"2025-10-02T10:41:04.000Z","size":5496,"stargazers_count":3,"open_issues_count":15,"forks_count":15,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-10-02T12:35:15.234Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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":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":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-01-27T16:17:17.000Z","updated_at":"2025-10-02T10:41:09.000Z","dependencies_parsed_at":"2024-02-25T20:29:42.695Z","dependency_job_id":"cd4e2813-efff-408b-85a3-a4ddb10e1505","html_url":"https://github.com/OpenBankProject/API-Explorer-II","commit_stats":null,"previous_names":["openbankproject/api-explorer-ii"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OpenBankProject/API-Explorer-II","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer-II","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer-II/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer-II/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer-II/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenBankProject","download_url":"https://codeload.github.com/OpenBankProject/API-Explorer-II/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FAPI-Explorer-II/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278343072,"owners_count":25971399,"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-10-04T02:00:05.491Z","response_time":63,"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":[],"created_at":"2024-11-15T19:48:13.268Z","updated_at":"2025-10-04T16:41:53.766Z","avatar_url":"https://github.com/OpenBankProject.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Welcome to the OBP API Explorer II\n=================================\n\n# ABOUT\n\nThis application is used to explore OBP APIs and interact with the data and services in the context of the logged in user.\n\nThis application will gradually replace the original API Explorer. Long live the API Explorer!\n\n\n\n## Install the Prerequisite Software\n  * required: { node: `\u003e=16.14` }\n  * required: { npm: `\u003e=8.0.0` }\n\n### Development Project Setup\n\n  * Setup your .env file (see .env.example)\n\n##### Install dependencies\n\n```sh\nyarn install\n```\nor\n```sh\nnpm install\n```\n\n##### Compile and Hot-Reload for Development\n\n```sh\nyarn dev\n```\nor\n```sh\nnpm run dev\n```\n\n##### Get a Consumer Key for the OBP-API\n\nAPI Explorer needs a Consumer Key / Secret to access the Open Bank Project API with OAuth.\nTo get this Consumer, go to the Portal of OBP-API, login and \"Get a Consumer Key\".\nThe callback URL (if running locally) should be http://localhost:5173/api/callback\nCopy and paste the Consumer Key and Consumer Secret and add it to your .env file here.\nYou can use .env.example as a basis of your .env file. \n\n### Testing\n\nUnit tests are located in `server/test` and `src/test`.\n\nIntegration tests are located in `src/test/integration`\n\n##### Run Unit Tests with [Vitest](https://vitest.dev/)\n\n\u003cstrike\u003e\n\n```sh\nnpm test\n```\n\u003c/strike\u003e\n\n##### Run Integration Tests with [Playwright](https://playwright.dev/)\n\n\n\n```sh\nnpx playwright test\n```\nor if you want a fancy testing UI to see what the browser is doing:\n```sh\nnpx playwright test ui\n```\n\n\n## Compile and Minify for Production\n\n##### Build \n\n```sh\nnpm run build\n```\n\n##### Build Server \n\n```sh\nnpm run build-server\n```\n\n\n\n##### Start the backend server\n```sh\nnpx ts-node \u003cpath-to-your-install\u003e/server/app.js\n```\n\n##### Check the status of API-Explorer II back-end\n```\nPlease find a message at a log file similar to this one:\n\nBackend is running. You can check a status at http://localhost:8085/api/status\n\nand use the link to check the status\n```\n\n\n##### Nginx deployment\n\n```config\nserver {\n    # Frontend\n    location / {\n        root    /path_to_dist/dist;\n        try_files $uri $uri/ /index.html;\n    }\n    \n    # Proxy API\n    location /api {\n        proxy_pass http://localhost:8085;\n    }\n}\n```\n\nNote: if you have issues with session stickyness / login issues, enable #DEBUG=express-session in your .env\nand if you see messages like these in the log,\n\n```\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session no SID sent, generating session\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session saving 5JIW_dx9CG8qs0OK4iv7Pn2Kg2huZuvQ\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session not secured\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session split response\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session saving -yf0uzAZf5mP9JVYov9oMR7CxQLnO4wm\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session not secured\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session no SID sent, generating session\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session saving nballQYMYZRn_HG0enM2RIPdv7GAdzJc\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session not secured\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session no SID sent, generating session\nDec 10 12:26:18 obp-sandbox node[1060160]: Tue, 10 Dec 2024 12:26:18 GMT express-session no SID sent, generating session\n\n```\n\nthen make sure your NGINX config includes the $scheme: \n\n```\n\nproxy_set_header X-Real-IP $remote_addr;\nproxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\nproxy_set_header X-Forwarded-Proto $scheme;\n\n```\n\nso that Node knows that the cookies have been sent securely over https.\n\n# Running Opey\nIf you want to run Opey locally you'll need to have a local instance running. The repo can be found [here](https://github.com/OpenBankProject/OBP-Opey). \n\nYou will need to create a public-private key pair using open ssl (minimum 2048 bits).\n1. create the directory ./server/cert\n  ```\n  mkdir ./server/cert\n  cd ./server/cert  \n  ```\n2. Generate the public private key pair inside the ./server/cert directory\n```\nopenssl genrsa -out private_key.pem 2048\nopenssl rsa -in private_key.pem -pubout -out public_key.pem\n```\n3. Copy the public key to Opey top level directory \n```\ncp public_key.pem {path-to-your-opey-install}/\n```\n\n# Building the frontend container\n\nAs the frontend environment is read at build time, we need to reprocess the values \nat container runtime. \nThis is done here: Dockerfiles/prestart.go\noverwriting the values set here: Dockerfiles/frontend_build.env\nAny newly introduced environment variables should be added to the prestart.go and frontend_build.env files accordingly.\n# LICENSE\n\nThis project is licensed under the AGPL V3 (see NOTICE) and a commercial license from TESOBE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fapi-explorer-ii","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbankproject%2Fapi-explorer-ii","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fapi-explorer-ii/lists"}