{"id":25943472,"url":"https://github.com/tobitsoftware/chayns-backendapi-helper","last_synced_at":"2025-06-26T10:36:08.949Z","repository":{"id":79522114,"uuid":"87190641","full_name":"TobitSoftware/Chayns-BackendApi-Helper","owner":"TobitSoftware","description":"Class library for easy access to the Chayns Backend API","archived":false,"fork":false,"pushed_at":"2019-03-06T09:46:02.000Z","size":45,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-06-09T12:08:01.318Z","etag":null,"topics":["chayns","chayns-backend-api","csharp-code","helper","jwt-authentication","restful-api","tobit"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TobitSoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2017-04-04T13:34:11.000Z","updated_at":"2019-03-06T09:46:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"5ea0d3fd-621a-400b-a7df-a08ac6c0e3f5","html_url":"https://github.com/TobitSoftware/Chayns-BackendApi-Helper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TobitSoftware/Chayns-BackendApi-Helper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobitSoftware%2FChayns-BackendApi-Helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobitSoftware%2FChayns-BackendApi-Helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobitSoftware%2FChayns-BackendApi-Helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobitSoftware%2FChayns-BackendApi-Helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TobitSoftware","download_url":"https://codeload.github.com/TobitSoftware/Chayns-BackendApi-Helper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobitSoftware%2FChayns-BackendApi-Helper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262049569,"owners_count":23250774,"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":["chayns","chayns-backend-api","csharp-code","helper","jwt-authentication","restful-api","tobit"],"created_at":"2025-03-04T07:16:49.415Z","updated_at":"2025-06-26T10:36:08.943Z","avatar_url":"https://github.com/TobitSoftware.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chayns Backend API Helper\nThe chayns backend api helper is dedicated to support you using the [backend api](https://github.com/TobitSoftware/chayns-backend) itself. \u003cbr\u003e\nIt shortens and simplifies many features of the api and makes the usage much more cleaned up.\n\n## Requirements\nFor using this project you will need the following prerequisites\n+ Visual Studio\n+ .NET Framework 4.6 or greater\n\n## Dependencies\nTo use this Project you will need the following package from nuget.org\n+ Newtonsoft.Json (\u003e= 8.0.3)\n\n## Getting started\nTo use this helper you will need to integrate it into your existing .NET Framework Project.\u003cbr\u003e\nYou can integrate this Project directly into your solution or just reference the `Chayns.Backend.dll` file you can find in the `/bin/Release` folder.\u003cbr\u003e\nTo create the file you need to open the solution. Change the build settings to `Release` and build the project, by pressing `F6`.\n\n## How to use\n### General\nWhen you have added the helper you get the new functionality using the namespace `Chayns.Backend`.\u003cbr\u003e\nUsing the helper you can shorten and simplify your requests to the chayns® backend api.\u003cbr\u003e\nThe controllers are named equal to the endpoints of the api.\n\n### Authentication\nTo authenticate your request you will need your secret and TappId (see the [chayns backend wiki](https://github.com/TobitSoftware/chayns-backend/wiki/Authorization)).\u003cbr\u003e\nYou can find the Secret in the Tapp Administration in the TSPN and the TappId can be found in the JavaScript Frontend API.\u003cbr\u003e\nYou can set default credentials for all of your requests, by calling\n```CSHARP \nChayns.Backend.Api.Credentials.Credentials.Initialize(new SecretCredentials(\"Secret\", TappId));\n```\nYou can also pass the credentials to every request by hand. The credentials manual set are always preferred.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobitsoftware%2Fchayns-backendapi-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftobitsoftware%2Fchayns-backendapi-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobitsoftware%2Fchayns-backendapi-helper/lists"}