{"id":17340277,"url":"https://github.com/biacode/joverheid","last_synced_at":"2025-03-27T08:40:41.489Z","repository":{"id":57738844,"uuid":"71439745","full_name":"Biacode/joverheid","owner":"Biacode","description":"Java implementation of Overheid.io API","archived":false,"fork":false,"pushed_at":"2020-10-14T14:32:48.000Z","size":67,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T13:28:31.872Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Biacode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-20T08:08:57.000Z","updated_at":"2020-10-14T14:32:42.000Z","dependencies_parsed_at":"2022-08-24T17:51:21.645Z","dependency_job_id":null,"html_url":"https://github.com/Biacode/joverheid","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/Biacode%2Fjoverheid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Biacode%2Fjoverheid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Biacode%2Fjoverheid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Biacode%2Fjoverheid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Biacode","download_url":"https://codeload.github.com/Biacode/joverheid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245812934,"owners_count":20676720,"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-10-15T15:44:30.163Z","updated_at":"2025-03-27T08:40:41.457Z","avatar_url":"https://github.com/Biacode.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"### CI Status\n[![Build Status](https://travis-ci.org/Biacode/joverheid.svg?branch=master)](https://travis-ci.org/Biacode/joverheid)\n[![SonarCube](https://getstreaming.files.wordpress.com/2012/10/sonar.png)](https://sonarqube.com/dashboard/index/com.sfl.joverheid:joverheid)\n# joverheid\nJava implementation of Overheid.io API\n# How to use\n\n### Installation\n\nFirst of all, you need any implementation of ```javax.ws.rs.client.Client```\nFor example you can use jersey client\n\nAdd the following dependency to your maven pom.xml file\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eorg.glassfish.jersey.core\u003c/groupId\u003e\n    \u003cartifactId\u003ejersey-client\u003c/artifactId\u003e\n    \u003cversion\u003e${jersey.client.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\nThen you need pass client implementation to OverheidClient as constructor param.\n\n# Example to construct client implementation in spring framework.\nIn application context XML add the following XML definition\n```java\n\u003cbean id=\"overheidJerseyClientBuilder\"\n          class=\"org.biacode.joverheid.api.configuration.impl.OverheidJerseyClientBuilderImpl\"/\u003e\n\n\u003cbean id=\"overheidJerseyClient\" factory-bean=\"overheidJerseyClientBuilder\" factory-method=\"build\"/\u003e\n\n\u003cbean id=\"overheidClient\" class=\"org.biacode.joverheid.api.client.impl.OverheidClientImpl\"\u003e\n    \u003cconstructor-arg name=\"client\" ref=\"overheidJerseyClient\"/\u003e\n\u003c/bean\u003e\n\n```\n\n# If you simply need to test overheid API.\nThen construct jersey client as follows\n```java\npackage my.application;\n\nimport com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;\nimport org.biacode.joverheid.api.client.OverheidClient;\nimport org.biacode.joverheid.api.client.impl.OverheidClientImpl;\nimport org.biacode.joverheid.api.model.common.OverheidResult;\nimport org.biacode.joverheid.api.model.request.GetCorporationsRequest;\nimport org.biacode.joverheid.api.model.response.GetCorporationsResponse;\n\nimport javax.ws.rs.client.ClientBuilder;\nimport java.util.HashMap;\nimport java.util.Map;\n\npublic class MainApplication {\n    public static void main(String[] args) {\n        // construct overheid java client\n        final OverheidClient overheidClient = new OverheidClientImpl(\n                ClientBuilder.newBuilder().register(JacksonJsonProvider.class).build(),\n                \"Your API key here\"\n        );\n        // you can build filters and pass them to the request constructor as follows\n        final Map\u003cString, String\u003e filters = new HashMap\u003c\u003e();\n        filters.put(\"size\", \"10\");\n        filters.put(\"filters[postcode]\", \"3083cz\");\n        final GetCorporationsRequest getCorporationsRequest = new GetCorporationsRequest(filters);\n        final OverheidResult\u003cGetCorporationsResponse\u003e corporations = overheidClient\n                .getCorporations(getCorporationsRequest);\n        // check if there is any error\n        if (corporations.hasError()) {\n            System.out.println(corporations.getError());\n        } else {\n            // the getResponse() will return the response models E.g. embedded and links\n            System.out.println(corporations.getResponse());\n            System.out.println(corporations.getResponse().getEmbedded());\n            System.out.println(corporations.getResponse().getLinks());\n        }\n    }\n}\n```\n\n# Available API calls\n**Get single corporation**\n```\noverheidClient.getCorporation(new GetCorporationRequest(12345, \"subdossier nummer here\"));\n```\n\n**Get corporations**\n```\noverheidClient.getCorporations(new GetCorporationsRequest(filters));\n```\n\n**Get dossier corporation**\n```\noverheidClient.getDossierCorporation(new GetDossierCorporationRequest(12345));\n```\n\n**Get suggestions**\n```\noverheidClient.getSuggestion(new SuggestionRequest(\"oudet\", filters));\n```\n\n# Best practices\nMake singleton of the ```OverheidClient``` so you do not need to construct the client for every API call \n\nThe official Overheid [documentation](https://overheid.io/documentatie/kvk)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiacode%2Fjoverheid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbiacode%2Fjoverheid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiacode%2Fjoverheid/lists"}