{"id":7253,"date":"2024-03-27T12:50:31","date_gmt":"2024-03-27T10:50:31","guid":{"rendered":"https:\/\/churchtools.academy\/?post_type=docs&#038;p=7253"},"modified":"2026-10-07T07:57:26","modified_gmt":"2026-10-07T05:57:26","password":"","slug":"api-dokumentation","status":"publish","type":"docs","link":"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/api-dokumentation\/","title":{"rendered":"API Dokumentation"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">Die RESTful API wird mit dem <a href=\"https:\/\/swagger.io\/specification\/\">OpenAPI Standard<\/a> (ehemals Swagger) dokumentiert. Jedes ChurchTools wird mit der Dokumentation ausgeliefert und kann \u00fcber einen Link wie <code>https:\/\/meine-gemeinde.church.tools\/api<\/code> aufgerufen werden. &nbsp;<\/p>\n\n\n\n<aside class=\"wp-block-group ct-box ct-box-blue has-background is-vertical is-layout-flex wp-container-core-group-is-layout-1ccdadb1 wp-block-group-is-layout-flex\" style=\"border-radius:8px;border-left-color:#3e70ce;border-left-width:0.5rem;background-color:#f3f5f7;margin-top:var(--wp--preset--spacing--60);margin-bottom:var(--wp--preset--spacing--60)\">\n<p class=\"wp-block-paragraph\" style=\"margin-top:0.5rem;margin-right:0.5rem;margin-bottom:0rem;margin-left:0.5rem\"><strong>Hinweis<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\" style=\"margin-top:0rem;margin-right:0.5rem;margin-bottom:0.5rem;margin-left:0.5rem\"><code>meine-gemeinde<\/code> muss hierbei ersetzt werden mit dem Namen der eigenen Installation.<\/p>\n<\/aside>\n\n\n\n<div style=\"position:relative;padding-top:56.25%;\"><iframe src=\"https:\/\/player.mediadelivery.net\/embed\/752823\/6b529217-c6a8-4905-94d3-276e69a5d2c3?autoplay=false&#038;loop=false&#038;muted=false&#038;preload=false&#038;responsive=true&#038;includeRum=false\" loading=\"lazy\" style=\"border:0;position:absolute;top:0;height:100%;width:100%;\" allow=\"accelerometer;gyroscope;autoplay;encrypted-media;picture-in-picture;fullscreen;\" allowfullscreen=\"true\"><\/iframe><\/div>\n\n\n\n<p class=\"wp-block-paragraph\">Die Dokumenation ist mit der Swagger-UI in ChurchTools integriert. Das bietet folgende Vorteile: &nbsp;<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Einfacher \u00dcberblick \u00fcber alle verf\u00fcgbaren Endpoints<\/li>\n\n\n\n<li>Testen: Die UI erlaubt es, direkt im Browser Requests abzufeuern und so die API zu testen<\/li>\n\n\n\n<li>ChurchTools-User: Ist man in ChurchTools eingeloggt, werden alle Requests \u00fcber die UI direkt mit dem eigenen Benutzer gesendet. So kann man die API schnell und einfach testen. &nbsp;<\/li>\n<\/ol>\n\n\n\n<aside class=\"wp-block-group ct-box ct-box-blue has-background is-vertical is-layout-flex wp-container-core-group-is-layout-1ccdadb1 wp-block-group-is-layout-flex\" style=\"border-radius:8px;border-left-color:#ef4444;border-left-width:0.5rem;background-color:#fee2e2;margin-top:var(--wp--preset--spacing--60);margin-bottom:var(--wp--preset--spacing--60)\">\n<p class=\"wp-block-paragraph\" style=\"margin-top:0.5rem;margin-right:0.5rem;margin-bottom:0rem;margin-left:0.5rem\"><strong>Achtung<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\" style=\"margin-top:0rem;margin-right:0.5rem;margin-bottom:0.5rem;margin-left:0.5rem\">Sollte der eigene Benutzer viele Berechtigungen besitzen, k\u00f6nnen \u00fcber die API auch Dinge ge\u00e4ndert oder gel\u00f6scht werden.<\/p>\n<\/aside>\n\n\n\n<figure class=\"wp-block-image size-full\"><a href=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API.png\"><img fetchpriority=\"high\" decoding=\"async\" width=\"2004\" height=\"1460\" src=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API.png\" alt=\"ChurchTools REST API\" class=\"wp-image-45063\" srcset=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API.png 2004w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-300x219.png 300w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-1024x746.png 1024w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-768x560.png 768w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-1536x1119.png 1536w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-360x262.png 360w\" sizes=\"(max-width: 2004px) 100vw, 2004px\" \/><\/a><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">API-Spezifikation als JSON-Datei<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Durch den Standard ist es m\u00f6glich, die ganze Dokumentation als JSON-Datei f\u00fcr eigene Projekte heranzuziehen. Die ganze Spezifikation ist \u00fcber den Link <code>https:\/\/meine-gemeinde.church.tools\/system\/runtime\/swagger\/openapi.json<\/code> erreichbar.<\/p>\n\n\n\n<aside class=\"wp-block-group ct-artikel-zum-weiterlesen has-background is-layout-constrained wp-container-core-group-is-layout-79a8db7e wp-block-group-is-layout-constrained\" style=\"border-radius:8px;background-color:#f9fafb;margin-top:24px;margin-bottom:24px;padding-top:32px;padding-right:24px;padding-bottom:32px;padding-left:24px\">\n<h2 class=\"wp-block-heading has-medium-font-size\">Artikel zum Weiterlesen<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/uberblick-api\/\" type=\"docs\" id=\"7251\">\u00dcberblick API<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/api-authentifizierung\/\" type=\"docs\" id=\"7252\">API Authentifizierung<\/a><\/li>\n<\/ul>\n<\/aside>\n","protected":false},"excerpt":{"rendered":"<p>Die RESTful API wird mit dem OpenAPI Standard (ehemals Swagger) dokumentiert. Jedes ChurchTools wird mit der Dokumentation ausgeliefert und kann \u00fcber einen Link wie https:\/\/meine-gemeinde.church.tools\/api aufgerufen werden. &nbsp; Die Dokumenation ist mit der Swagger-UI in ChurchTools integriert. Das bietet folgende Vorteile: &nbsp; API-Spezifikation als JSON-Datei Durch den Standard ist es m\u00f6glich, die ganze Dokumentation als [&hellip;]<\/p>\n","protected":false},"author":7,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"footnotes":""},"doc_category":[370],"doc_tag":[268],"knowledge_base":[346],"class_list":["post-7253","docs","type-docs","status-publish","hentry","doc_category-api","doc_tag-inhalt-veraltet","knowledge_base-system-einstellungen"],"pp_statuses_selecting_workflow":false,"pp_workflow_action":"current","pp_status_selection":"publish","pp_force_visibility":null,"pp_subpost_visibility":null,"pp_inherited_force_visibility":null,"pp_inherited_subpost_visibility":null,"acf":[],"year_month":"2026-11","word_count":141,"total_views":"4453","reactions":{"happy":"0","normal":"1","sad":"3"},"author_info":{"name":"Victoria Weidemann","author_nicename":"vweidemann","author_url":"https:\/\/churchtools.academy\/de\/author\/vweidemann\/"},"doc_category_info":[{"term_name":"API","term_url":"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/"}],"doc_tag_info":[{"term_name":"Inhalt veraltet","term_url":"https:\/\/churchtools.academy\/de\/docs-tag\/inhalt-veraltet\/"}],"knowledge_base_info":[{"term_name":"System-Einstellungen","term_url":"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/","term_slug":"system-einstellungen"}],"knowledge_base_slug":["system-einstellungen"],"_links":{"self":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs\/7253","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/comments?post=7253"}],"version-history":[{"count":14,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs\/7253\/revisions"}],"predecessor-version":[{"id":97614,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs\/7253\/revisions\/97614"}],"wp:attachment":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/media?parent=7253"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/doc_category?post=7253"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/doc_tag?post=7253"},{"taxonomy":"knowledge_base","embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/knowledge_base?post=7253"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}