This documentation is set up as a reference guide and is intended to give you all the details you need to use our API.
As you scroll, you'll find code samples for using the API in different programming languages area to the right. You may change the language being used using the drop-down.
According to resource type, API endpoints are arranged. According on your needs, you'll need to employ various endpoints.
An access token enables one to make API requests. The token itself is just a string of characters that you present to the API like a password.But it also performs some other important functions.
First, it identifies your end user.
Second, it determines the range of permissible actions, or scopes, that can perform be performed.
All API queries except few require a valid "access_token" recieved after login to establish the identity of the principal making the request.
This endpoint is for getting all release notes.
curl --request GET \
--get "https://admin.jmanual.org/api/release-note" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"release_note": [
{
"handle": "version-v13",
"title": "Version v1.3",
"release_date": "24th Oct,2023",
"description": "<p>dhgfhf</p>"
},
]
}
}This endpoint is for getting any release note.
Provide slug of release note : Required
curl --request GET \
--get "https://admin.jmanual.org/api/show-release-note?slug=example-slug-release-note" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"tempora\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"release_note": [
{
"handle": "version-v13",
"title": "Version v1.3",
"release_date": "24th Oct,2023",
"description": "<p>dhgfhf</p>"
}
]
}
}This endpoint allows user to login.
curl --request POST \
"https://admin.jmanual.org/api/login" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\",
\"password\": \"johndoe\"
}"
{
"token_type": "Bearer",
"expires_in": 31622400,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiMTE3MDhhZDAxMDA0YjcwN2VmMmI0MDQ2Y2U0YTA5YWNiZjkyM2E3Njg5NzVmM2UxZTFlNTg1MmUwNmIwZjg2NDBjYTVlNGY4MDU4YjIwNmYiLCJpYXQiOjE2ODQ5MDUyNTUuMDY2MjI4LCJuYmYiOjE2ODQ5MDUyNTUuMDY2MjMxLCJleHAiOjE3MTY1Mjc2NTUuMDQzNDA3LCJzdWIiOiI0Iiwic2NvcGVzIjpbIioiXX0.uuMMGMjxCUhEUi26tMlJJB9xXOdTFyIidY0UmFX7HJvm0KHz8eFsW_9CFkd1WFHX32KyDReiCmAgfZ4bfjCKck_6kGnm-J8-U59Ehi8kSv11Ohi8leZyhi8f4mWDDgXWB1PuP3k1GDwMmQvwbSAvpOPTJMs8ljSrfYlKxv0u9vcGzRa3nMZBGrYk7nF4EafIGrGnsIZW8gzhlBu63uDXW3BfFmVhxLGkuBJgR1g7ukg9aH_1oP6fQSHEo9ANaKARiUF4hMa8Te5-c6G_vX4O2WKouL6AKnNIQWi3fRu55QD6-CdAanlFjPfhEuwlL-GBK_Kxg2RO3u9izqcUll-zLvSdCLzSB6mKGiA76CuEzgNZRVkFuaierAEtevpO4Do-tYnC6JKpn4pOhouAwf7FuWpRj2oQVoEW-ynkWdWYU7JBGhuZOqq9U_VJ8PACFg5zwHHnN0ZnAB_aTVSRFNguufxZ97lYhbL1_UxKPEhy6py6N0mosiZ1r2Vx5mYhcztS0p64rU6P64tp57qVADRHEVOkOXt7dBUnn9td9k9ZRO0UfKiim7y86ZZyDVpNkE8sh9hdtmYyA5M6RbTvGd_HfE70w62OORkiR-TbgjZZC7n6ofLarneG0BXi7JJz0TdlhUecbvgyGbA7b3RqB0ZRdDl5V_NTUxqTePJAZ0aCPrs",
"refresh_token": "def50200a0e93090756ecfbfc7144b0e9fb5d8dd2c18643466118938c30ba8580d4640fa31e80ae994f27bb8727ab4a5266c3c393847f2c8d48235046a5d502788d3662bcad170e84ea80a9288abc18545d9937b363b47ff42ec998144c577f1ef821cf7badeaee15b58110f400e8fd6699b116dd5de1c0470165db0b4c15c0bfba692ccd6050de4a1150a3c2658c04a75db9253834453da77615c08b336108bb5f6fd602f4bae4d3ebefc42cf76a01d964306dc823e9eeef08d1f9a8e16beb2755f2e437a78a71aa855bc564afaa1be78348a4ca1c7864120042d37c7c15b3c7d302648105731d8365960d4d31a45e82aa621c31350932cf35d5e0e783f83b7a1d04c2de80e4cebc6997e9b132599355f7a388d9d35a772d627c4758d7f9f345e630fa88e577c0803e884e2990689182efba8b634d03c9fa7cf8d5362b05b086fda2970172f31ece8fc8fae87b28e0950c3838321218e4af508672b861d9e2b7e512e6e",
"success": true,
"message": "Token generated successfully.",
"slug": "john-doe"
}This endpoint allows user to set password, after a link recieved from an email.
Following the link in the email would return a token in the URL for setting the password.
curl --request POST \
"https://admin.jmanual.org/api/generate-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"weOTpGMdNXRJtVNjH9fZ4uFlyorOG7dS50qJHulT3BUaJSj6HZARLZ6L4VdE6t2b\",
\"password\": \"john@1234\",
\"password_confirmation\": \"john@1234\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Password generated successfully.",
"password_set": true
}
}This endpoint allows a user to request for reset password link in their email.
Following the link in the email would return a token in the URL for resetting the password.
curl --request POST \
"https://admin.jmanual.org/api/retrieve-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Retrieve password mail sent successfully.",
"retrieve_password": true
}
}This endpoint allows a user to reset password.
curl --request POST \
"https://admin.jmanual.org/api/submit-forget-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"weOTpGMdNXRJtVNjH9fZ4uFlyorOG7dS50qJHulT3BUaJSj6HZARLZ6L4VdE6t2b\",
\"password\": \"john@1234\",
\"password_confirmation\": \"john@1234\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Password has been changed successfully.",
"retrieve_password": true
}
}This endpoint allows user to logout.
curl --request POST \
"https://admin.jmanual.org/api/logout" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{{
"data": {
"success": true,
"status_code": 200,
"message": "You have been successfully logged out",
"logged_out": [
true
]
}
}This endpoint is for the global items.
curl --request GET \
--get "https://admin.jmanual.org/api/global-response" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Get data of Global Response",
"global": [
{
"template_type": [
{
"name": "Brit Milah",
"handle": "brit-milah"
}
],
"language": [
{
"name": "hebrew",
"handle": "hebrew"
}
],
"tags": [
{
"name": "Passover",
"handle": "passover"
},
{
"name": "Newborn",
"handle": "newborn"
}
]
}
]
}
}This endpoint is to display uses statistics data on dashboard
curl --request GET \
--get "https://admin.jmanual.org/api/user-statistics" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Succesful",
"user_statistics": {
"clips": {
"label": "My Clips",
"total": 0,
"shared": 0,
"published": 0,
"draft": 0,
"archived": 0
},
"templates": {
"label": "My Templates",
"total": 1,
"shared": 1,
"published": 1,
"draft": 0,
"archived": 0
},
"ceremonies": {
"label": "My Ceremonies",
"total": 0,
"shared": 0,
"published": 0,
"draft": 0,
"archived": 0
},
"documents": {
"label": "My Documents",
"total": 0,
"shared": 0,
"published": 0,
"draft": 0,
"archived": 0
}
}
}
}This endpoint allows to get user profile details.
curl --request GET \
--get "https://admin.jmanual.org/api/show-user" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "User Information Updated Successfully",
"user": [
{
"details": {
"handle": "john-doe",
"email": "[email protected]",
"first_name": "John",
"middle_name": "Thanos",
"last_name": "Doe",
"full_name": "John Doe",
"author_initials": "JD",
"bio": Hello this is John ,
"image": null
}
}
]
}
}This endpoint allows to update user profile details.
curl --request POST \
"https://admin.jmanual.org/api/user-profile-data" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": \"JoeNew\",
\"last_name\": \"Thomas\",
\"middle_name\": \"Thomas\",
\"bio\": \"Hello this is John\"
}"
This endpoint allows to update user account password.
curl --request POST \
"https://admin.jmanual.org/api/user-password" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"current_password\": \"john@1234\",
\"new_password\": \"newjohn@1234\",
\"confirm_password\": \"newjohn@1234\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Password changed successfully.",
"change_password": true
}
}This endpoint allows to upload user profile image.
curl --request POST \
"https://admin.jmanual.org/api/upload-profile-pic" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"profile_image\": \"\\\"https:\\/\\/haggadot.us-east-1.linodeobjects.com\\/temp_api_images\\/1675254463.jpeg\\\"\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Profile picture changed successfully",
"user": [
{
"details": {
"handle": "john-doe",
"email": "[email protected]",
"first_name": "John",
"middle_name": "Thanos",
"last_name": "Doe",
"full_name": "John Doe",
"author_initials": "JD",
"bio": null,
"image": "us-east-1.linodeobjects.com/users/1/conversions/1684996768-thumb.jpg"
}
}
]
}
}This endpoint allows to remove user profile image.
curl --request POST \
"https://admin.jmanual.org/api/remove-profile-pic" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Profile picture removed successfully",
"user": [
{
"details": {
"handle": "john-doe",
"email": "[email protected]",
"first_name": "John",
"middle_name": "Thanos",
"last_name": "Doe",
"full_name": "John Doe",
"author_initials": "JD",
"bio": null,
"image": null
}
}
]
}
}This endpoint is to get the template data based on ceremony selected.
Provide handle of ceremony type : Required
Provide handle of template type
curl --request GET \
--get "https://admin.jmanual.org/api/ceremony-templates?slug=example-handle-ceremony&template_type=example-handle-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"template_types": [
{
"name": "Brit Milah",
"handle": "brit-milah"
},
{
"name": "Simchat Bat",
"handle": "simchat-bat"
},
{
"name": "Baby Naming",
"handle": "baby-naming"
}
]
}
}This endpoint is for create new ceremony.
curl --request POST \
"https://admin.jmanual.org/api/create-new-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ceremony_type\": \"example-handle-ceremony-type\",
\"ceremony_title\": \"example-title\",
\"ceremony_place\": \"example-ceremony-place\",
\"ceremony_date\": \"2023-06-11\",
\"template_type\": \"example-handle-template-type\",
\"template_slug\": \"example-handle-template\",
\"household\": {
\"key\": [
{
\"slug\": \"example-handle-household\",
\"participant\": {
\"key\": [
{
\"step_label\": 0,
\"slug\": 0,
\"role\": \"father\"
}
]
}
}
]
},
\"witness\": {
\"key\": [
{
\"first_name_english\": \"example-first-name-english\",
\"first_name_hebrew\": \"example-first-name-hebrew\",
\"last_name_english\": \"example-last-name-english\",
\"last_name_hebrew\": \"example-last-name-hebrew\",
\"title\": \"example-handle\",
\"relation_english\": \"example-handle-relation-english\",
\"relation_hebrew\": \"example-handle-relation-hebrew\",
\"convert\": 1,
\"tribe\": \"example-handle-tribe\",
\"family_name\": \"example-family-name\",
\"pronoun\": \"example-handle-pronoun\"
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "New ceremony created successfully",
"ceremony": {
"slug": "testing-creating-ceremony"
}
}
}This endpoint is for updating any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/update-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ceremony_slug\": \"example-handle-ceremony\",
\"ceremony_version_name\": \"Version 01\",
\"save_as_version\": 1,
\"ceremony_title\": \"example-title-ceremony\",
\"ceremony_place\": \"example-ceremony-place\",
\"ceremony_date\": \"2023-06-11\",
\"official_greetings\": \"example-official-greeting\",
\"official_remarks\": \"example-official-remarks\",
\"status\": \"0\",
\"ceremony_tags\": [
\"comedy\"
],
\"sections\": {
\"key\": [
{
\"section_slug\": \"example-section-title-english\",
\"section_title_english\": \"example-section-title-english\",
\"section_title_hebrew\": \"example-section-title-hebrew\",
\"clips\": {
\"key\": [
{
\"clip_slug\": \"example-clip-title-english\",
\"clip_title_english\": \"example-clip-title-english\",
\"clip_title_hebrew\": \"example-clip-title-hebrew\",
\"clip_content_english\": \"example-clip-content-english\",
\"clip_content_hebrew\": \"example-clip-content-hebrew\",
\"media_type\": \"text\",
\"image\": \"\\\"https:\\/\\/haggadot.us-east-1.linodeobjects.com\\/temp_api_images\\/1675254463.jpeg\\\"\",
\"audio\": \"expedita\",
\"video_url\": \"\\\"https:\\/\\/youtu.be\\/Hl_Oltt6TD0\\\"\",
\"video_image\": \"\\\"https:\\/\\/i.ytimg.com\\/vi\\/-9tUWhNmQz4\\/hqdefault.jpg\\\"\",
\"embed_code\": \"ullam\",
\"is_from_sefaria_api\": 1,
\"personal_note\": \"example-clip-personal-note\",
\"marked_as_stage_direction\": 1
}
]
}
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Update successfully.",
"ceremony": true
}
}This endpoint enables user to archive any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/archive-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Archived successfully",
"ceremony": []
}
}This endpoint enables user to un-archive any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/unarchive-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony UnArchived successfully",
"ceremony": []
}
}This endpoint is for deleting a ceremony.
curl --request POST \
"https://admin.jmanual.org/api/delete-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Deleted Successfully",
"delete_ceremony": []
}
}This endpoint is for linking any ceremony with a document folder.
curl --request POST \
"https://admin.jmanual.org/api/ceremony-document-folder" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ceremony_slug\": \"example-handle-ceremony\",
\"document_folder_slug\": \"example-handle-document\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Folder Details Updated Successfully",
"ceremony_document": []
}
}This endpoint is for retrieving the document folder linked to any ceremony.
Provide handle of ceremony : Required
curl --request GET \
--get "https://admin.jmanual.org/api/get-ceremony-folder?slug=example-handle-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"folder": [
{
"is_admin": 1,
"is_owner": 1,
"name": "the first folder+file name chnaged",
"handle": "the-first-folderfile-name-chnaged",
"author": "admin test",
"author_handle": "admin",
"author_initials": "AT",
"total_files": 7,
"total_notes": 6,
"file_details": [
{
"file_name": "ahe first file",
"handle": "ahe-first-file",
"url": "https://raca.us-east-1.linodeobjects.com/uploads/the first file.docx",
"is_bookmarked": 0,
"author": "admin test",
"author_handle": "admin",
"author_initials": "AT",
"is_shared": 1,
"is_archived": 0,
"uploaded_on": "Aug 01 2023",
"updated_at": "Aug 04 2023",
"language": "English",
"language_slug": "english",
"tags": [
{
"tag": "Wedding",
"slug": "wedding"
},
{
"tag": "Couple",
"slug": "couple"
}
]
}
],
"note_details": [
{
"title": "bhe second note",
"handle": "the-second-note",
"description": "the second note description",
"author": "admin test",
"author_handle": "admin",
"author_initials": "AT",
"created_on": "Aug 02 2023",
"updated_at": "Aug 02 2023",
"tags": []
}
]
}
]
}
}
}This endpoint is for getting the steps required for any ceremony type.
Provide handle of ceremony type : Required
curl --request GET \
--get "https://admin.jmanual.org/api/ceremony-step?slug=example-handle-ceremony-type" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"ceremony_steps": [
{
"step_02": {
"step_label": "participant",
"household": [
{
"household_label": "Household A",
"participant": [
{
"participant_label": "First Participant",
"required": true
}
]
},
{
"household_label": "Household B",
"participant": [
{
"participant_label": "First Participant",
"required": true
}
]
}
],
"this_is_last_step": false
},
"step_03": {
"step_label": "individual",
"individual": [
{
"individual_label": "First Individual",
"required": false
},
{
"individual_label": "Second Individual",
"required": false
},
{
"individual_label": "Third Individual",
"required": false
}
],
"witness": [
{
"witness_label": "First Witness",
"required": false
},
{
"witness_label": "Second Witness",
"required": false
}
],
"this_is_last_step": true
}
}
]
}
}This endpoint is previewing the checklist.
Provide handle of the ceremony.: Required
curl --request GET \
--get "https://admin.jmanual.org/api/ceremony-checklist?slug=example-handle-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"checklist": [
{
"id": 1,
"title": "test-first",
"is_checked": 1
}
]
}
}This endpoint is for updating the checklist for the Ceremony.
This api call manages to create and update the existing checklist for the ceremony.
curl --request POST \
"https://admin.jmanual.org/api/update-ceremony-checklist" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"checklist\": {
\"key\": [
{
\"id\": 1,
\"title\": \"hello John doe\",
\"is_checked\": 1
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"checklist": [
{
"id": 1,
"title": "testjskgdvksdkjv",
"is_checked": 1
}
]
}
}This endpoint is for printing the checklist of any ceremony.
Provide handle of ceremony : Required
curl --request GET \
--get "https://admin.jmanual.org/api/print-ceremony-checklist?slug=example-handle-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Checklist Generated Successfully",
"print_template_checklist": {
"url": "http://haggadot.raca.sr/exports/ceremony/testing creating ceremony_checklist.pdf"
}
}
}This endpoint is for Export CSV ceremony checklist.
Provide handle of ceremony : Required
curl --request GET \
--get "https://admin.jmanual.org/api/export-csv-ceremony-checklist?slug=example-handle-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"architecto\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Checklist Generated Successfully",
"print_template_checklist": {
"url": "http://haggadot.raca.sr/exports/ceremony/testing creating ceremony_checklist.pdf"
}
}
}This endpoint is to add participants and/or Witness to ceremony.
curl --request POST \
"https://admin.jmanual.org/api/store-ceremony-participant" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"household\": {
\"key\": [
{
\"slug\": \"example-handle-household\",
\"participant\": {
\"key\": [
{
\"step_label\": 0,
\"slug\": 0,
\"role\": \"father\"
}
]
}
}
]
},
\"witness\": {
\"key\": [
{
\"first_name_english\": \"example-first-name-english\",
\"first_name_hebrew\": \"example-first-name-hebrew\",
\"last_name_english\": \"example-last-name-english\",
\"last_name_hebrew\": \"example-last-name-hebrew\",
\"title\": \"example-handle\",
\"relation_english\": \"example-handle-relation-english\",
\"relation_hebrew\": \"example-handle-relation-hebrew\",
\"convert\": 1,
\"tribe\": \"example-handle-tribe\",
\"family_name\": \"example-family-name\",
\"pronoun\": \"example-handle-pronoun\"
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Participants Added Succesfully",
"ceremony_participant": []
}
}This endpoint is to show participants and witness information in ceremony.
Provide handle of ceremony. : Required
curl --request GET \
--get "https://admin.jmanual.org/api/ceremony-participant?slug=example-handle-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"ceremony_participant": {
"participant_details": {
"weiss-family": [
{
"ceremony_role": "child",
"step_index": 2,
"title": "harav",
"slug": "adrain-en",
"first_name_english": "Adrain_en",
"first_name_hebrew": "Adrain_he",
"last_name_english": "Weiss_en",
"last_name_hebrew": "Weiss_he",
"relation_english": "father",
"relation_hebrew": "abba",
"convert": 0,
"tribe": "cohen",
"family_name": "ruzicka",
"pronoun": "he",
"living_status": 1
},
]
},
"witness": [],
"contact_information": [
{
"name": "Weiss Family",
"slug": "weiss-family",
"total_records": 2,
"status": "Active",
"updated_at": "June 2023",
"email": "[email protected]",
"address": "2464 Royal Ln. Mesa, New Jersey 45463",
"city": "Dallas",
"state": "Texas",
"zip_code": "75444",
"home_phone": "(808) 555-0111",
"cell_phone": "(209) 555-0104",
"detail_records": [
{
"title": "harav",
"slug": "adrain-en",
"first_name_english": "Adrain_en",
"first_name_hebrew": "Adrain_he",
"last_name_english": "Weiss_en",
"last_name_hebrew": "Weiss_he",
"relation_english": "father",
"relation_hebrew": "abba",
"convert": 0,
"tribe": "cohen",
"family_name": "ruzicka",
"pronoun": "he",
"living_status": 1
}
]
}
]
}
}
}This endpoint is for saving any ceremony as template.
curl --request POST \
"https://admin.jmanual.org/api/save-as-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"title\": \"example-title-template\",
\"type\": \"brit-milah\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony generated successfully",
"save_as_template": "Template Has Been Saved Successfully"
}
}This endpoint is for duplicating any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/duplicate-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Has Been Duplicated Successfully",
"duplicate_ceremony": []
}
}This endpoint is for getting user ceremonies.
For filtering and sorting the data ,one can specify multiple value by passing a comma separated list of available property name.
Sorting is ascending by default and can be reversed(descending) by adding a hyphen (-) to the start of the property name.
Handle of Ceremony type
To be passed only when needed the shared list of ceremony
Sorting the resource
Available property name: created, modified, title, upcoming
Tab of the screen (Active or Archive)
Available property name: 1 (Published) = Active, 2 = Archived
curl --request GET \
--get "https://admin.jmanual.org/api/user-ceremony?filter%5Bceremony%5D=example-handle-ceremony-type&filter%5Bshared%5D=1&sort=-title&filter%5Bstatus%5D=2" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"ceremonies": [
{
"ceremomy": {
"is_admin": 1,
"is_owner": 1,
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title": "testing creating ceremony second",
"slug": "testing-creating-ceremony-second-1",
"ceremony_date": null,
"ceremomy_place": null,
"status": "published",
"is_shared": 0,
"ceremomy_type_name": "Welcoming New Life",
"ceremomy_type_handle": "welcoming-new-life",
"template_type_name": "Brit Milah",
"template_type_handle": "brit-milah",
"tags": [
{
"tag": "Wedding",
"handle": "wedding"
}
]
}
}
]
},
"links": {
"first": "http://raca.haggadot.sr/api/user-ceremony?page=1",
"last": "http://raca.haggadot.sr/api/user-ceremony?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.haggadot.sr/api/user-ceremony?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.haggadot.sr/api/user-ceremony",
"per_page": 18,
"to": 1,
"total": 1,
"user_statistics": {
"clips": {
"label": "My Clips",
"total": 1,
"shared": 1,
"published": 1,
"draft": 0,
"archived": 0
},
"templates": {
"label": "My Templates",
"total": 2,
"shared": 1,
"published": 1,
"draft": 0,
"archived": 1
},
"ceremonies": {
"label": "My Ceremonies",
"total": 3,
"published": 1,
"draft": 2,
"archived": 0
},
"documents": {
"label": "My Documents",
"total": 0,
"shared": 0,
"published": 0,
"draft": 0,
"archived": 0
}
}
}
}This endpoint is for sharing ceremony over email
curl --request POST \
"https://admin.jmanual.org/api/share-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"list\": {
\"key\": [
{
\"email\": \"Welcome@invite\"
}
]
},
\"message\": \"Welcome Message for Invitee\",
\"permission\": \"edit\"
}"
This endpoint is for removing the collaborator of the ceremony.
curl --request POST \
"https://admin.jmanual.org/api/remove-ceremony-collaborator" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"token\": \"abcASgfhvisgkjsdgbvudgfukjivghdfkjghauei\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Collaborator Removed Succesfully",
"remove_ceremony_collaborator": []
}
}This endpoint is to get the collaborator of any ceremony.
Provide handle of ceremony : Required
curl --request GET \
--get "https://admin.jmanual.org/api/get-ceremony-collaborator?slug=example-handle-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Get Ceremony Collaborator",
"get_ceremony_collaborator": [
{
"name": "You",
"name_initials": "DD",
"status": "Owner"
},
{
"name": "Akshat Pancholi",
"name_initials": "AP",
"token": "nwIcgGXnK7JS7aYbBHWWsBB4nPkBmWftnruSiZ2VWfE8cUtLWsInMw3YbypZGO9A",
"status": "Collaborator"
}
]
}
}This endpoint is for exporting a ceremony.
Provide handle of ceremony : Required
Provide layout type to download ceremony : Required
Available values: landscape, portrait
Default: portrait
Provide format type to download ceremony : Required
Available values: pdf, word, presentation
Default: pdf
Provide personal_note type to download ceremony : Required
Available values: 1, 0
Default: 0
Provide stage_direction type to download ceremony : Required
Available values: 1, 0
Default: 0
curl --request GET \
--get "https://admin.jmanual.org/api/ceremony-export?slug=example-handle-ceremony&layout=landscape&format=word&personal_note=0&stage_direction=0" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"vel\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony generated successfully",
"export_ceremony": {
"url": "https://devracabackend.recustom.com/ceremony/testingcreateceremonyc4ca4238a0b923820dcc509a6f75849b.pdf"
}
}
}This endpoint is for getting all details of ceremony.
Provide handle of ceremony. : Required
Provide token in case of no authentication available
Provide handle of ceremony-version in case of ceremony version preview
curl --request GET \
--get "https://admin.jmanual.org/api/ceremony-detail?slug=example-handle-ceremony&token=HfsOwsDBOkkU9wrSyDENEroEWzUoDYJFYEBnbDBVfnkE4ilaWyMHhhNEikeScUta&version_slug=example-handle-ceremony-version" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"ceremonies": [
{
"ceremomy": {
"is_admin": 1,
"is_owner": 1,
"author": "John Doe",
"author_handle": "john-doe",
"author_initials": "JD",
"title": "testing creating ceremony",
"slug": "testing-creating-ceremony-1",
"ceremony_date": null,
"ceremomy_place": null,
"status": "draft",
"is_shared": 0,
"ceremomy_type_name": "Welcoming New Life",
"ceremomy_type_handle": "welcoming-new-life",
"template_type_name": "Brit Milah",
"template_type_handle": "brit-milah",
"tags": [
{
"tag": "Wedding",
"handle": "wedding"
}
],
"sections": [
{
"section_title": "Official Grettings",
"section_description": null
},
{
"section_title": {
"en": "werewr",
"he": "hebrew title 1"
},
"section_slug": "werewr-1",
"section_position": 1,
"clips": [
{
"clip": {
"is_admin": 1,
"is_owner": 1,
"is_bookmarked": 0,
"handle": "qwqwqw-4",
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title_english": "qwqwqw",
"title_hebrew": "clip title hebewre 22",
"description_english": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod\ntempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,\nquis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo\nconsequat. Duis aute irure dolor in reprehenderit in voluptate velit esse\ncillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non\nproident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"description_hebrew": "מנוע חיפוש תרגום אנגלית-עברית, מילים וביטויים באנגלית מתורגמים לעברית עם דוגמאות לשימוש בשתי השפות. צימוד לעברית",
"personal_instruction": null,
"cliptype": "image",
"is_featured": 0,
"is_shared": 0,
"status": "draft",
"language": "English",
"language_slug": "english",
"media": {
"image": "https://raca.us-east-1.linodeobjects.com/clips/7/AdobeStock_79093125-cover.jpg",
"image_thumbnail": "https://raca.us-east-1.linodeobjects.com/clips/7/conversions/AdobeStock_79093125-cover-cover.jpg",
"audio": null,
"video": null
},
"tags": [],
"position": 1,
"marked_as_staged": 1
}
}
],
"total_clips": 3
},
{
"section_title": "Officiant Conclusion Remarks",
"section_description": null
}
]
}
}
]
}
}This endpoint is for accepting the shared ceremony over email
curl --request POST \
"https://admin.jmanual.org/api/accept-share-ceremony" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"abcASgfhvisgkjsdgbvudgfukjivghdfkjghauei\"
}"
This endpoint is for storing a comment in a ceremony.
This api requires authentication only when a user comments on their own ceremony.
Else a token field is required in the api-request if the user is not authenticated.
curl --request POST \
"https://admin.jmanual.org/api/store-comment-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"clip_slug\": \"example-handle-clip\",
\"comment\": \"This is my comment on the clip\",
\"token\": \"AGRAOIRGHVDUYRTGOAIEUHBVFIRUETYUEIRGFVRUGBduysfUISRGFU\"
}"
This endpoint enables user to rename any version for any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/rename-ceremony-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"title\": \"title-ceremony\",
\"version_slug\": \"example-handle-ceremony-version\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Version Renamed Succesfully",
"rename_ceremony_version": []
}
}This endpoint enables user to retsore any version for any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/restore-ceremony-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"version_slug\": \"example-handle-ceremony-version\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Version Restored",
"restore_ceremony_version": []
}
}This endpoint enables user to delete any version for any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/delete-ceremony-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-ceremony\",
\"version_slug\": \"example-handle-ceremony-version\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Ceremony Version Deleted Succesfully",
"delete_ceremony_version": []
}
}This endpoint is for getting all ceremony version.
Provide handle of ceremony : Required
curl --request GET \
--get "https://admin.jmanual.org/api/get-ceremony-version?slug=example-handle-ceremony-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Get ceremony detail",
"get_ceremony_version": {
"total_ceremony_version": 4,
"ceremony_version": [
{
"title": "Version 1",
"slug": "version-1",
"created_by": "admin",
"is_current": 0,
"created_at": "Sep 27,09:26am",
"updated_at": "Sep 27,09:26am"
}
]
}
}
}This endpoint allows user to create a new template.
curl --request POST \
"https://admin.jmanual.org/api/create-new-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template_type\": \"example-handle-template-type\",
\"template_title\": \"example-title-template\",
\"status\": 0,
\"language\": \"english\",
\"template_tags\": [
\"comedy\"
],
\"sections\": {
\"key\": [
{
\"section_title_english\": \"example-section-title-english\",
\"section_title_hebrew\": \"example-section-title-hebrew\",
\"clips\": {
\"key\": [
{
\"clip_title_english\": \"example-clip-title-english\",
\"clip_title_hebrew\": \"example-clip-title-hebrew\",
\"clip_content_english\": \"example-clip-content-english\",
\"clip_content_hebrew\": \"example-clip-content-hebrew\",
\"media_type\": \"text\",
\"image\": \"\\\"https:\\/\\/haggadot.us-east-1.linodeobjects.com\\/temp_api_images\\/1675254463.jpeg\\\"\",
\"audio\": \"vero\",
\"video_url\": \"\\\"https:\\/\\/youtu.be\\/Hl_Oltt6TD0\\\"\",
\"video_image\": \"\\\"https:\\/\\/i.ytimg.com\\/vi\\/-9tUWhNmQz4\\/hqdefault.jpg\\\"\",
\"embed_code\": \"ipsam\",
\"is_from_sefaria_api\": 1,
\"personal_note\": \"example-clip-personal-note\",
\"marked_as_stage_direction\": 1
}
]
}
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template created successfully.",
"template": {
"handle": "testing-create-template"
}
}
}This endpoint allows user to edit a Template.
curl --request POST \
"https://admin.jmanual.org/api/update-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template_slug\": \"example-handle-template\",
\"template_version_name\": \"Version 01\",
\"save_as_version\": 1,
\"template_type\": \"example-handle-template-type\",
\"template_title\": \"example-title-template\",
\"status\": 0,
\"language\": \"english\",
\"template_tags\": [
\"comedy\"
],
\"sections\": {
\"key\": [
{
\"section_slug\": \"example-section-title-english\",
\"section_title_english\": \"example-section-title-english\",
\"section_title_hebrew\": \"example-section-title-hebrew\",
\"clips\": {
\"key\": [
{
\"clip_slug\": \"example-clip-title-english\",
\"clip_title_english\": \"example-clip-title-english\",
\"clip_title_hebrew\": \"example-clip-title-hebrew\",
\"clip_content_english\": \"example-clip-content-english\",
\"clip_content_hebrew\": \"example-clip-content-hebrew\",
\"media_type\": \"text\",
\"image\": \"\\\"https:\\/\\/haggadot.us-east-1.linodeobjects.com\\/temp_api_images\\/1675254463.jpeg\\\"\",
\"audio\": \"non\",
\"video_url\": \"\\\"https:\\/\\/youtu.be\\/Hl_Oltt6TD0\\\"\",
\"video_image\": \"\\\"https:\\/\\/i.ytimg.com\\/vi\\/-9tUWhNmQz4\\/hqdefault.jpg\\\"\",
\"embed_code\": \"quibusdam\",
\"is_from_sefaria_api\": 1,
\"personal_note\": \"example-clip-personal-note\",
\"marked_as_stage_direction\": 1
}
]
}
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template Update successfully.",
"template": true
}
}This endpoint is for delete template.
curl --request POST \
"https://admin.jmanual.org/api/delete-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template Deleted Successfully",
"delete_template": []
}
}This endpoint enables user to bookmark any Template.
curl --request POST \
"https://admin.jmanual.org/api/bookmark-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template Bookmarked successfully",
"template": []
}
}This endpoint enables user to un-bookmark any Template.
curl --request POST \
"https://admin.jmanual.org/api/unbookmark-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template UnBookmarked successfully",
"template": []
}
}This endpoint enables user to archive any template.
curl --request POST \
"https://admin.jmanual.org/api/archive-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template Archived successfully",
"template": []
}
}This endpoint enables user to un-archive any template.
curl --request POST \
"https://admin.jmanual.org/api/unarchive-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template UnArchived successfully",
"template": []
}
}This endpoint allows user to duplicate any template.
curl --request POST \
"https://admin.jmanual.org/api/duplicate-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template Checklist Generated Successfully",
"duplicate_template": "Template Has Been Duplicated Successfully"
}
}This endpoint is for previewing any template.
Provide handle of the template for display template data : Required
curl --request GET \
--get "https://admin.jmanual.org/api/edit-template?slug=example-handle-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"molestias\"
}"
{
"data": {
"template": {
"is_admin": 1,
"is_owner": 1,
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title": "testing create template",
"slug": "testing-create-template",
"template_type": "brit-milah",
"status": "published",
"is_shared": 0,
"language": "hebrew",
"tags": [],
"sections": [
{
"position": 1,
"title": {
"en": "werewr",
"he": ""
},
"clips": [
{
"clip": {
"is_admin": 1,
"is_owner": 1,
"is_bookmarked": 0,
"handle": "qwqwqw",
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title_english": "qwqwqw",
"title_hebrew": "clip title hebewre 22",
"description_english": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod\ntempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,\nquis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo\nconsequat. Duis aute irure dolor in reprehenderit in voluptate velit esse\ncillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non\nproident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"description_hebrew": "מנוע חיפוש תרגום אנגלית-עברית, מילים וביטויים באנגלית מתורגמים לעברית עם דוגמאות לשימוש בשתי השפות. צימוד לעברית",
"personal_instruction": "",
"cliptype": "image",
"is_featured": 0,
"is_shared": 0,
"status": "Draft",
"language": "english",
"media": {
"image": "https://raca.us-east-1.linodeobjects.com/clips/1/AdobeStock_79093125-cover.jpg",
"audio": null,
"video": null
},
"tags": []
}
}
]
}
]
}
}
}This endpoint allows user to share their Templates to library.
curl --request POST \
"https://admin.jmanual.org/api/share-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\",
\"status\": \"1\"
}"
This endpoint would display available template resource, along with the filtering and sorting of data.
For filtering and sorting the data ,one can specify multiple value by passing a comma separated list of available property name.
For active tab, do pass both the available values(0,1) to get list of user's draft and published resource respectively.
Sorting is ascending by default and can be reversed(descending) by adding a hyphen (-) to the start of the property name.
Provide template type handle for filter the data
Tab of the screen (Active or Archive)
Available property name: 0 (Draft) , 1 (Published) = Active, 2 = Archived
Sorting the resource
Available property name: created, modified, title
curl --request GET \
--get "https://admin.jmanual.org/api/user-template?filter%5Btemplate%5D=brit-milah&filter%5Bstatus%5D=0%2C1&sort=-title" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"templates": [
{
"template": {
"is_admin": 1,
"is_owner": 1,
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title": "testing create template",
"slug": "testing-create-template",
"template_type": "brit-milah",
"status": "published",
"is_shared": 0,
"language": "hebrew",
"tags": []
}
}
]
},
"links": {
"first": "http://raca.haggadot.sr/api/user-template?page=1",
"last": "http://raca.haggadot.sr/api/user-template?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.haggadot.sr/api/user-template?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.haggadot.sr/api/user-template",
"per_page": 18,
"to": 1,
"total": 1,
"user_total_template": 1
}
}This endpoint is for retrieving user's bookmarked clips.
curl --request GET \
--get "https://admin.jmanual.org/api/user-template-bookmark" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"templates": [
{
"template": {
"is_admin": 1,
"is_owner": 1,
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title": "testing create template",
"slug": "testing-create-template",
"template_type": "brit-milah",
"status": "published",
"is_shared": 0,
"language": "hebrew",
"tags": []
}
}
]
},
"links": {
"first": "http://raca.haggadot.sr/api/user-template-bookmark?page=1",
"last": "http://raca.haggadot.sr/api/user-template-bookmark?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.haggadot.sr/api/user-template-bookmark?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.haggadot.sr/api/user-template-bookmark",
"per_page": 18,
"to": 1,
"total": 1,
"user_statistics": {
"clips": {
"label": "My Clips",
"total": 0,
"shared": 0,
"published": 0,
"draft": 0,
"archived": 0
},
"templates": {
"label": "My Templates",
"total": 1,
"shared": 1,
"published": 1,
"draft": 0,
"archived": 0
},
"ceremonies": {
"label": "My Ceremonies",
"total": 0,
"shared": 0,
"published": 0,
"draft": 0,
"archived": 0
},
"documents": {
"label": "My Documents",
"total": 0,
"shared": 0,
"published": 0,
"draft": 0,
"archived": 0
}
}
}
}This endpoint is for exporting a template.
Provide handle of template : Required
Provide layout type to download template : Required
Available values: landscape, portrait
Default: portrait
Provide format type to download template : Required
Available values: pdf, word
Default: pdf
Provide personal_note type to download template : Required
Available values: 1, 0
Default: 0
Provide stage_direction type to download template : Required
Available values: 1, 0
Default: 0
curl --request GET \
--get "https://admin.jmanual.org/api/template-export?slug=example-handle-template&layout=landscape&format=word&personal_note=0&stage_direction=0" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Template generated successfully",
"export_template": {
"url": "https://devracabackend.recustom.com/template/testingcreatetemplatec4ca4238a0b923820dcc509a6f75849b.pdf"
}
}
}This endpoint is previewing checklist
Provide handle of template for create new checklist : Required
curl --request GET \
--get "https://admin.jmanual.org/api/template-checklist?slug=example-handle-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"checklist": [
{
"id": 5,
"title": "test-first",
"is_checked": 1
},
{
"id": 6,
"title": "test-second",
"is_checked": 0
}
]
}
}This endpoint is to update the checklist for the template.
This api call manages to create and update the existing checklist for the template.
curl --request POST \
"https://admin.jmanual.org/api/update-template-checklist" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\",
\"checklist\": {
\"key\": [
{
\"id\": 1,
\"title\": \"hello John doe\",
\"is_checked\": 1
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"checklist": [
{
"id": 1,
"title": "test-first",
"is_checked": 1
},
{
"id": 2,
"title": "test-seconddvsdvsdv",
"is_checked": 1
}
]
}
}This endpoint is for print a template checklist.
Provide handle of print template : Required
curl --request GET \
--get "https://admin.jmanual.org/api/print-template-checklist?slug=example-handle-template" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"eaque\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template Checklist Generated Successfully",
"print_template_checklist": {
"url": "http://raca.haggadot.sr/exports/template/Testing_checklist.pdf"
}
}
}This endpoint is for Export CSV template checklist.
Provide handle of print template : Required
curl --request GET \
--get "https://admin.jmanual.org/api/export-csv-template-checklist?slug=example-handle-template" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"aperiam\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template Checklist Generated Successfully",
"export_template": {
"url": "http://raca.haggadot.sr/exports/template/Testing.csv"
}
}
}This endpoint is for creating/updating the instructions for any template.
curl --request POST \
"https://admin.jmanual.org/api/update-template-instruction" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\",
\"instruction\": {
\"key\": [
{
\"slug\": \"example-handle-instruction\",
\"title\": \"hello John doe\",
\"description\": \"<p>hello John doe<\\/p>\"
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"instruction": [
{
"slug": "test-first-templateinstruction",
"title": "test-first-templateinstruction",
"description": "description first"
},
{
"slug": "test-second-templateinstruction",
"title": "test-second-templateinstruction",
"description": "description second"
},
{
"slug": "test-third-templateinstruction",
"title": "test-third-templateinstruction",
"description": "description third"
}
]
}
}This endpoint is for retrieving the instructions for any template.
Provide handle of template : Required
curl --request GET \
--get "https://admin.jmanual.org/api/get-template-instruction?slug=example-handle-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"instruction": [
{
"slug": "test-first-templateinstruction",
"title": "test-first-templateinstruction",
"description": "description first"
},
{
"slug": "test-second-templateinstruction",
"title": "test-second-templateinstruction",
"description": "description second"
},
{
"slug": "test-third-templateinstruction",
"title": "test-third-templateinstruction",
"description": "description third"
}
]
}
}This endpoint enables user to restore any version for any ceremony.
curl --request POST \
"https://admin.jmanual.org/api/restore-template-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\",
\"version_slug\": \"example-handle-template-version\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template version restored successfully.",
"restore_template_version": []
}
}This endpoint enables user to rename any version for any template.
curl --request POST \
"https://admin.jmanual.org/api/rename-template-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\",
\"version_slug\": \"example-handle-template-version\",
\"title\": \"title-ceremony\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template version name updated successfully",
"rename_template_version": []
}
}This endpoint enables user to delete any version for any template.
curl --request POST \
"https://admin.jmanual.org/api/delete-template-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-template\",
\"version_slug\": \"example-handle-template-version\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Template version deleted successfully",
"delete_template_version": []
}
}This endpoint is for getting all template version.
Provide handle of template : Required
curl --request GET \
--get "https://admin.jmanual.org/api/get-template-version?slug=example-handle-template-version" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Get template detail",
"get_template_version": {
"total_template_version": 5,
"template_version": [
{
"title": "Version 01",
"slug": "version-01",
"created_by": "john-doe",
"is_current": 0,
"created_at": "Sep 29,06:59am",
"updated_at": "Sep 29,07:38am"
}
]
}
}
}This endpoint allows user to share their clips to library.
curl --request POST \
"https://admin.jmanual.org/api/share-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\",
\"status\": \"1\"
}"
This endpoint would display available clip resource, along with the filtering and sorting of data.
For filtering and sorting the data ,one can specify multiple value by passing a comma separated list of available property name.
For active tab, do pass both the available values(0,1) to get list of user's draft and published resource respectively.
Sorting is ascending by default and can be reversed(descending) by adding a hyphen (-) to the start of the property name.
Filtering the data based on media type
Available property name: text, image, video, audio
Default: all
Tab of the screen (Active or Archive)
Available property name: 0 (Draft) , 1 (Published) = Active, 2 = Archived
Sorting the resource
Available property name: created, modified, title
curl --request GET \
--get "https://admin.jmanual.org/api/user-clip?filter%5Bcliptype%5D=text&filter%5Bstatus%5D=0%2C1&sort=-title" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": "200",
"message": "Successful",
"clips": [
{
"clip": {
"is_admin": 0,
"is_owner": 1,
"is_bookmarked": 0,
"handle": "hello-every-one",
"author": "John Doe",
"author_handle": "john-doe",
"author_initials": "JD",
"title_english": "hello every one",
"title_hebrew": "עִבְרִית",
"description_english": "This is done for testing create clip api",
"description_hebrew": "עִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתע",
"personal_instruction": null,
"cliptype": "video",
"is_featured": 0,
"is_shared": 1,
"status": "Published",
"language": "english",
"media": {
"image": null,
"audio": null,
"video": "https://youtu.be/Hl_Oltt6TD0"
},
"tags": []
}
}
]
},
"links": {
"first": "http://raca.sr/api/user-clip?page=1",
"last": "http://raca.sr/api/user-clip?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.sr/api/user-clip?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.sr/api/user-clip",
"per_page": 18,
"to": 2,
"total": 2,
"user_total_clips": 2
}
}This endpoint is for retrieving user's bookmarked clips.
curl --request GET \
--get "https://admin.jmanual.org/api/user-clip-bookmark" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": "200",
"message": "Successful",
"clips": [
{
"clip": {
"is_admin": 0,
"is_owner": 1,
"is_bookmarked": 1,
"handle": "testing-for-second-time",
"author": "John Doe",
"author_handle": "john-doe",
"author_initials": "JD",
"title_english": "testing for second time",
"title_hebrew": "עִבְרִית",
"description_english": "This is done for testing create clip api",
"description_hebrew": "עִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתע",
"personal_instruction": null,
"cliptype": "video",
"is_featured": 0,
"is_shared": 1,
"status": "Published",
"language": "english",
"media": {
"image": null,
"audio": null,
"video": "https://youtu.be/Hl_Oltt6TD0"
},
"tags": []
}
}
]
},
"links": {
"first": "http://raca.sr/api/user-clip-bookmark?page=1",
"last": "http://raca.sr/api/user-clip-bookmark?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.sr/api/user-clip-bookmark?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.sr/api/user-clip-bookmark",
"per_page": 18,
"to": 1,
"total": 1,
"user_total_clips": 2
}
}This endpoint is for sharing clip over email
curl --request POST \
"https://admin.jmanual.org/api/clip-share" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\",
\"permission\": \"view\",
\"list\": {
\"key\": [
{
\"email\": \"Welcome@invite\"
}
]
},
\"message\": \"Welcome Message for Invitee\"
}"
This endpoint allows user to export their clip.
Provide handle of the clip for export of clips : Required
Provide layout type to download clip : Required
Available values: landscape, portrait
Default: portrait
Provide format type to download clip : Required
Available values: pdf, word
Default: pdf
curl --request GET \
--get "https://admin.jmanual.org/api/clip-export?slug=example-handle-clip&layout=landscape&format=word" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Clip generated successfully",
"export_clip": {
"url": "http://haggadot.raca.sr/clips/testing-language1685778800.pdf"
}
}
}This endpoint is for accepting the shared clip over email
curl --request POST \
"https://admin.jmanual.org/api/accept-share-clip" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"abcASgfhvisgkjsdgbvudgfukjivghdfkjghauei\"
}"
This endpoint is for previewing any clip.
Provide handle of the clip for display clip data : Required
curl --request GET \
--get "https://admin.jmanual.org/api/show-clip?slug=example-handle-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": "200",
"message": "Successful",
"clips": [
{
"clip": {
"is_admin": 0,
"is_owner": 1,
"is_bookmarked": 0,
"handle": "hello-every-one",
"author": "John Doe",
"author_handle": "john-doe",
"author_initials": "JD",
"title_english": "hello every one",
"title_hebrew": "עִבְרִית",
"description_english": "This is done for testing create clip api",
"description_hebrew": "עִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתע",
"personal_instruction": null,
"cliptype": "video",
"is_featured": 0,
"is_shared": 1,
"status": "Published",
"language": "english",
"media": {
"image": null,
"audio": null,
"video": "https://youtu.be/Hl_Oltt6TD0"
},
"tags": []
}
}
]
}
}This endpoint allows user to create a new clip.
curl --request POST \
"https://admin.jmanual.org/api/create-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title_english\": \"example-title-clip\",
\"title_hebrew\": \"example-title-clip\",
\"title_spanish\": \"dbdgnonlbupjqjchcwwuyjr\",
\"media_type\": \"text\",
\"content_english\": \"This is my first clip.\",
\"content_hebrew\": \"This is my first clip.\",
\"status\": \"0\",
\"language\": \"english\",
\"tag\": [
\"comedy\"
],
\"image\": \"\\\"https:\\/\\/haggadot.us-east-1.linodeobjects.com\\/temp_api_images\\/1675254463.jpeg\\\"\",
\"audio\": \"perferendis\",
\"video_url\": \"\\\"https:\\/\\/youtu.be\\/Hl_Oltt6TD0\\\"\",
\"source_image\": \"\\\"https:\\/\\/i.ytimg.com\\/vi\\/-9tUWhNmQz4\\/hqdefault.jpg\\\"\",
\"embed_code\": \"ea\",
\"is_from_sefaria_api\": 1
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "New clip created successfully",
"clip": {
"handle": "testing-api"
}
}
}This endpoint allows user to edit a clip.
curl --request POST \
"https://admin.jmanual.org/api/edit-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-slug-clip\",
\"title_english\": \"example-title-clip\",
\"title_hebrew\": \"example-title-clip\",
\"title_spanish\": \"ekjs\",
\"media_type\": \"text\",
\"content_english\": \"This is my first clip.\",
\"content_hebrew\": \"This is my first clip.\",
\"status\": \"0\",
\"language\": \"english\",
\"tag\": [
\"comedy\"
],
\"image\": \"\\\"https:\\/\\/haggadot.us-east-1.linodeobjects.com\\/temp_api_images\\/1675254463.jpeg\\\"\",
\"audio\": \"perspiciatis\",
\"video_url\": \"\\\"https:\\/\\/youtu.be\\/Hl_Oltt6TD0\\\"\",
\"source_image\": \"\\\"https:\\/\\/i.ytimg.com\\/vi\\/-9tUWhNmQz4\\/hqdefault.jpg\\\"\",
\"embed_code\": \"eum\"
}"
{
"data": {
"success": true,
"status_code": "200",
"message": "Successful",
"clips": [
{
"clip": {
"is_admin": 0,
"is_owner": 1,
"is_bookmarked": 0,
"handle": "testing-for-second-time",
"author": "John Doe",
"author_handle": "john-doe",
"author_initials": "JD",
"title_english": "testing for second time",
"title_hebrew": "עִבְרִית",
"description_english": "This is done for testing create clip api",
"description_hebrew": "עִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתעִבְרִיתע",
"personal_instruction": null,
"cliptype": "video",
"is_featured": 0,
"is_shared": 0,
"status": "Draft",
"language": "english",
"media": {
"image": null,
"audio": null,
"video": "https://youtu.be/Hl_Oltt6TD0"
},
"tags": []
}
}
]
}
}This endpoint enables users to delete clip.
curl --request POST \
"https://admin.jmanual.org/api/delete-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Clip Bookmarked successfully",
"clip": []
}
}This endpoint enables user to bookmark any clip.
curl --request POST \
"https://admin.jmanual.org/api/bookmark-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Clip Deleted Successfully",
"clip": []
}
}This endpoint enables user to un-bookmark any clip.
curl --request POST \
"https://admin.jmanual.org/api/unbookmark-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Clip UnBookmarked successfully",
"clip": []
}
}This endpoint enables user to archive any clip.
curl --request POST \
"https://admin.jmanual.org/api/archive-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Clip Archived successfully",
"clip": []
}
}This endpoint enables user to un-archive any clip.
curl --request POST \
"https://admin.jmanual.org/api/unarchive-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Clip UnArchived successfully",
"clip": []
}
}This endpoint enables users to duplicate any clip.
curl --request POST \
"https://admin.jmanual.org/api/duplicate-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Clip Has Been Duplicated Successfully",
"duplicate_clip": []
}
}This endpoint is to create household.
curl --request POST \
"https://admin.jmanual.org/api/create-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"john doe\",
\"email\": \"[email protected]\",
\"address\": \"example-address\",
\"city\": \"example-city\",
\"state\": \"example-state\",
\"zip_code\": \"123456\",
\"home_phone\": \"123456789\",
\"cell_phone\": \"123456789\",
\"household\": {
\"key\": [
{
\"first_name_english\": \"example-first-name-english\",
\"first_name_hebrew\": \"example-first-name-hebrew\",
\"last_name_english\": \"example-last-name-english\",
\"last_name_hebrew\": \"example-last-name-hebrew\",
\"title\": \"example-handle\",
\"relation_english\": \"example-handle-relation-english\",
\"relation_hebrew\": \"example-handle-relation-hebrew\",
\"convert\": 1,
\"tribe\": \"example-handle-tribe\",
\"family_name\": \"example-family-name\",
\"pronoun\": \"example-handle-pronoun\",
\"living_status\": 1
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"household": [
{
"name": "Weiss Family",
"slug": "weiss-family",
"total_records": 0,
"status": "Active",
"updated_at": "June 2023",
"email": "[email protected]",
"address": "2464 Royal Ln. Mesa, New Jersey 45463",
"city": "Dallas",
"state": "Texas",
"zip_code": "75444",
"home_phone": "(808) 555-0111",
"cell_phone": "(209) 555-0104",
"detail_records": []
}
]
}
}This endpoint is for update the household
curl --request POST \
"https://admin.jmanual.org/api/edit-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-household\",
\"name\": \"john doe\",
\"email\": \"[email protected]\",
\"address\": \"example-address\",
\"city\": \"example-city\",
\"state\": \"example-state\",
\"zip_code\": \"123456\",
\"home_phone\": \"123456789\",
\"cell_phone\": \"123456789\",
\"household\": {
\"key\": [
{
\"slug\": \"example-handle-slug;\",
\"first_name_english\": \"example-first-name-english\",
\"first_name_hebrew\": \"example-first-name-hebrew\",
\"last_name_english\": \"example-last-name-english\",
\"last_name_hebrew\": \"example-last-name-hebrew\",
\"title\": \"example-handle\",
\"relation_english\": \"example-handle-relation-english\",
\"relation_hebrew\": \"example-handle-relation-hebrew\",
\"convert\": 1,
\"tribe\": \"example-handle-tribe\",
\"family_name\": \"example-family-name\",
\"pronoun\": \"example-handle-pronoun\",
\"living_status\": 1
}
]
}
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"household": [
{
"name": "Weiss Family 2",
"slug": "weiss-family-2",
"total_records": 0,
"status": "Active",
"updated_at": "June 2023",
"email": "[email protected]",
"address": "2464 Royal Ln. Mesa, New Jersey 45463",
"city": "Dallas",
"state": "Texas",
"zip_code": "123456",
"home_phone": "(808) 555-0111",
"cell_phone": "(209) 555-0104",
"detail_records": []
}
]
}
}This endpoint is for previewing any household.
Provide handle of the household. : Required
curl --request GET \
--get "https://admin.jmanual.org/api/get-household?slug=example-handle-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"household": [
{
"name": "Weiss Family 2",
"slug": "weiss-family-2",
"total_records": 0,
"status": "Active",
"updated_at": "June 2023",
"email": "[email protected]",
"address": "2464 Royal Ln. Mesa, New Jersey 45463",
"city": "Dallas",
"state": "Texas",
"zip_code": "123456",
"home_phone": "(808) 555-0111",
"cell_phone": "(209) 555-0104",
"detail_records": []
}
]
}
}This endpoint is for delete Household
curl --request POST \
"https://admin.jmanual.org/api/delete-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-household\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Household deleted successfully",
"household": []
}
}This endpoint enables user to archive any household.
curl --request POST \
"https://admin.jmanual.org/api/archive-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-household\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Household Archived successfully",
"household": []
}
}This endpoint enables user to unarchive any household.
curl --request POST \
"https://admin.jmanual.org/api/unarchive-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-household\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Household UnArchived successfully",
"household": []
}
}This endpoint is for get user household
Provide term for searching household name
Tab of the screen (Active or Archive)
Available property name: 1 (Published) = Active, 2 = Archived
Provide, if listing the households groupwise
curl --request GET \
--get "https://admin.jmanual.org/api/user-household?search=example-search&filter%5Bstatus%5D=2&list=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"household": [
{
"name": "Weiss Family 2",
"slug": "weiss-family-2",
"total_records": 0,
"status": "Active",
"updated_at": "June 2023"
}
]
},
"links": {
"first": "http://raca.haggadot.sr/api/user-household?page=1",
"last": "http://raca.haggadot.sr/api/user-household?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.haggadot.sr/api/user-household?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.haggadot.sr/api/user-household",
"per_page": 18,
"to": 1,
"total": 1,
"user_statistics": []
}
}This endpoint enables user to delete any household record.
curl --request POST \
"https://admin.jmanual.org/api/delete-household-record" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-household-record\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Household Record Deleted Successfully",
"household": []
}
}This endpoint allows user for duplicating a household.
curl --request POST \
"https://admin.jmanual.org/api/duplicate-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-household\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Household Duplicated Successfully",
"household": []
}
}This endpoint is for exporting any household as csv.
Provide handle of the household. : Required
curl --request GET \
--get "https://admin.jmanual.org/api/household-export?slug=example-handle-household" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{}This endpoint allows user to create a new folder.
curl --request POST \
"https://admin.jmanual.org/api/create-new-folder" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"example-name-folder\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Folder Created Successfully",
"folder": {
"is_admin": 1,
"is_owner": 1,
"name": "the first folder + file",
"handle": "the-first-folder-file",
"author": "john doe",
"author_handle": "john-doe",
"author_initials": "JD",
"total_files": 0
}
}
}This endpoint allows user to get all folder details.
curl --request GET \
--get "https://admin.jmanual.org/api/get-folder" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"folder": [
{
"is_admin": 1,
"is_owner": 1,
"name": "the first folder+file name chnaged",
"handle": "the-first-folderfile-name-chnaged",
"author": "john doe",
"author_handle": "john-doe",
"author_initials": "JD",
"total_files": 4
},
{
"is_admin": 1,
"is_owner": 1,
"name": "she first folder+file name chnaged",
"handle": "the-first-folderfile-name-chnaged-1",
"author": "john doe",
"author_handle": "john-doe",
"author_initials": "JD",
"total_files": 0
}
]
}
}This endpoint allows user to get any folder's details.
Sorting is ascending by default and can be reversed(descending) by adding a hyphen (-) to the start of the property name.
Provide handle for the folder : Required
Sorting the resources
Available property name: created, modified, title
curl --request GET \
--get "https://admin.jmanual.org/api/get-folder-detail?slug=example-handle-folder&sort=-title" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"folder": [
{
"is_admin": 1,
"is_owner": 1,
"name": "the first folder+file name chnaged",
"handle": "the-first-folderfile-name-chnaged",
"author": "john doe",
"author_handle": "john-doe",
"author_initials": "JD",
"total_files": 4,
"file_details": [
{
"file_name": "the first file",
"handle": "the-first-file",
"url": "https://raca.us-east-1.linodeobjects.com/uploads/the first file.docx",
"is_shared": 1,
"is_archived": 0,
"uploaded_on": "2023-08-01T06:21:20.000000Z",
"language": "English",
"language_slug": "english",
"tags": []
}
],
"note_details": [
{
"title": "the first note",
"handle": "the-first-note",
"description": "the first note description changed haha",
"tags": [
{
"tag": "Wedding",
"slug": "wedding"
}
]
}
]
}
]
}
}This endpoint allows user to rename any folder.
curl --request POST \
"https://admin.jmanual.org/api/rename-folder" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-folder\",
\"name\": \"example-new-name-folder\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Folder Renamed Successfully",
"folder": {
"is_admin": 1,
"is_owner": 1,
"name": "the first folder+file name chnaged",
"handle": "the-first-folderfile-name-chnaged-2",
"author": "john doe",
"author_handle": "john-doe",
"author_initials": "JD",
"total_files": 0
}
}
}This endpoint allows user to delete any folder.
curl --request POST \
"https://admin.jmanual.org/api/delete-folder" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-folder\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Folder Deleted Successfully",
"folder": []
}
}This endpoint is for getting user folders.
For sorting the data ,one can specify multiple value by passing a comma separated list of available property name.
Sorting is ascending by default and can be reversed(descending) by adding a hyphen (-) to the start of the property name.
Sorting the resource
Available property name: created, modified, title
curl --request GET \
--get "https://admin.jmanual.org/api/user-folder?sort=-title" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"folder": [
{
"is_admin": 1,
"is_owner": 1,
"name": "the first folder+file name chnaged",
"handle": "the-first-folderfile-name-chnaged",
"author": "john doe",
"author_handle": "john-doe",
"author_initials": "JD",
"total_files": 5,
"total_notes": 6
}
]
},
"links": {
"first": "http://haggadot.raca.sr/api/user-folder?page=1",
"last": "http://haggadot.raca.sr/api/user-folder?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://haggadot.raca.sr/api/user-folder?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://haggadot.raca.sr/api/user-folder",
"per_page": 18,
"to": 2,
"total": 2,
"user_statistics": {
"clips": {
"label": "My Clips",
"total": 23,
"shared": 2,
"published": 3,
"draft": 20,
"archived": 0,
"bookmarked": 1
},
"templates": {
"label": "My Templates",
"total": 18,
"shared": 1,
"published": 1,
"draft": 16,
"archived": 1,
"bookmarked": 2
},
"ceremonies": {
"label": "My Ceremonies",
"total": 12,
"published": 1,
"draft": 11,
"archived": 0
},
"documents": {
"label": "My Documents",
"total_folder": 2,
"total_file": 6,
"total_shared_file": 3
}
}
}
}This endpoint allows user to upload a new document to a folder.
curl --request POST \
"https://admin.jmanual.org/api/upload-document-to-folder" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-name-folder\",
\"file_name\": \"example-name-file\",
\"language\": \"hebrew\",
\"is_shared\": \"1\",
\"tag\": [
\"comedy\"
],
\"file\": \"data:image\\/png;base64,iVBOR.....................................FAAAAABJRU5ErkJggg==\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Uploaded Succesfully",
"folder": []
}
}This endpoint allows user to update any document details.
curl --request POST \
"https://admin.jmanual.org/api/update-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\",
\"file_name\": \"example-name-file\",
\"language\": \"hebrew\",
\"is_shared\": \"1\",
\"tag\": [
\"comedy\"
]
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Updated Successfully",
"folder": []
}
}This endpoint allows user to move any document to another folder.
curl --request POST \
"https://admin.jmanual.org/api/move-document-to-folder" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"folder_slug\": \"example-handle-folder\",
\"file_slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Moved To Folder Successfully",
"folder": []
}
}This endpoint allows user to share any document to library.
curl --request POST \
"https://admin.jmanual.org/api/share-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\",
\"status\": \"1\"
}"
This endpoint allows user to delete any document.
curl --request POST \
"https://admin.jmanual.org/api/delete-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Deleted Successfully",
"folder": []
}
}This endpoint allows user to bookmark any document.
curl --request POST \
"https://admin.jmanual.org/api/bookmark-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Bookmarked Successfully",
"folder": []
}
}This endpoint allows user to unbookmark any document.
curl --request POST \
"https://admin.jmanual.org/api/unbookmark-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document UnBookmarked Successfully",
"folder": []
}
}This endpoint allows user to archive any document.
curl --request POST \
"https://admin.jmanual.org/api/archive-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Archived Successfully",
"folder": []
}
}This endpoint allows user to unarchive any document.
curl --request POST \
"https://admin.jmanual.org/api/unarchive-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document UnArchived Successfully",
"folder": []
}
}This endpoint allows user to duplicate any document in a folder.
curl --request POST \
"https://admin.jmanual.org/api/duplicate-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Duplicated Successfully",
"folder": []
}
}This endpoint allows user to mark any document as favorite.
curl --request POST \
"https://admin.jmanual.org/api/mark-favorite-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Marked As Favorite Successfully",
"folder": []
}
}This endpoint allows user to remove any document from favorite.
curl --request POST \
"https://admin.jmanual.org/api/unmark-favorite-document" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-file\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Document Removed As Favorite Successfully",
"folder": []
}
}This endpoint would display available documents, along with the filtering data.
For filtering the data ,one can specify multiple value by passing a comma separated list of available property name.
Sorting is ascending by default and can be reversed(descending) by adding a hyphen (-) to the start of the property name.
Tab of the screen (Overview or Archive)
Available property value: 0 (Overview) = Not Archived , 1 = Archived
Get Favorite Document in Overview or Archive
Available property value: 0 = Not Favorite , 1 = Favorite
Sorting the resource
Available property name: created, modified, title
curl --request GET \
--get "https://admin.jmanual.org/api/user-document?filter%5Bstatus%5D=0%2C1&filter%5Bfavorite%5D=1&sort=-title" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"document": [
{
"file_name": "ahe first file",
"handle": "ahe-first-file",
"url": "https://raca.us-east-1.linodeobjects.com/uploads/the first file.docx",
"is_shared": 1,
"is_archived": 0,
"uploaded_on": "2023-08-01T06:21:20.000000Z",
"language": "English",
"language_slug": "english",
"tags": []
}
]
},
"links": {
"first": "http://haggadot.raca.sr/api/user-document?page=1",
"last": "http://haggadot.raca.sr/api/user-document?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://haggadot.raca.sr/api/user-document?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://haggadot.raca.sr/api/user-document",
"per_page": 18,
"to": 6,
"total": 6,
"user_statistics": {
"clips": {
"label": "My Clips",
"total": 23,
"shared": 2,
"published": 3,
"draft": 20,
"archived": 0,
"bookmarked": 1
},
"templates": {
"label": "My Templates",
"total": 18,
"shared": 1,
"published": 1,
"draft": 16,
"archived": 1,
"bookmarked": 2
},
"ceremonies": {
"label": "My Ceremonies",
"total": 12,
"published": 1,
"draft": 11,
"archived": 0
},
"documents": {
"label": "My Documents",
"total_folder": 2,
"total_file": 6,
"total_shared_file": 4
}
}
}
}This endpoint is for retrieving user's bookmarked documents.
curl --request GET \
--get "https://admin.jmanual.org/api/user-document-bookmark" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"document": [
{
"file_name": "ahe first file",
"handle": "ahe-first-file",
"url": "https://raca.us-east-1.linodeobjects.com/uploads/the first file.docx",
"is_shared": 1,
"is_archived": 0,
"uploaded_on": "2023-08-01T06:21:20.000000Z",
"language": "English",
"language_slug": "english",
"tags": []
}
]
},
"links": {
"first": "http://haggadot.raca.sr/api/user-document-bookmark?page=1",
"last": "http://haggadot.raca.sr/api/user-document-bookmark?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://haggadot.raca.sr/api/user-document-bookmark?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://haggadot.raca.sr/api/user-document-bookmark",
"per_page": 18,
"to": 1,
"total": 1,
"user_statistics": {
"clips": {
"label": "My Clips",
"total": 23,
"shared": 2,
"published": 3,
"draft": 20,
"archived": 0,
"bookmarked": 1
},
"templates": {
"label": "My Templates",
"total": 18,
"shared": 1,
"published": 1,
"draft": 16,
"archived": 1,
"bookmarked": 2
},
"ceremonies": {
"label": "My Ceremonies",
"total": 12,
"published": 1,
"draft": 11,
"archived": 0
},
"documents": {
"label": "My Documents",
"total_folder": 2,
"total_file": 6,
"total_shared_file": 4
}
}
}
}This endpoint allows user to export a document.
Provide handle of document : Required
curl --request GET \
--get "https://admin.jmanual.org/api/document-export?slug=example-handle-document" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{}This endpoint allows user to create a note in a folder.
curl --request POST \
"https://admin.jmanual.org/api/store-note" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-folder\",
\"title\": \"example-title-note\",
\"description\": \"example-description-note\",
\"tag\": [
\"comedy\"
]
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Note Created Successfully",
"folder": []
}
}This endpoint allows user to get a note in a folder.
Provide handle of note : Required
curl --request GET \
--get "https://admin.jmanual.org/api/get-note?slug=example-handle-note" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"folder": [
{
"title": "ahe first note",
"handle": "the-first-note",
"description": "the first note description changed haha",
"tags": [
{
"tag": "Wedding",
"slug": "wedding"
}
]
}
]
}
}This endpoint allows user to update a note in a folder.
curl --request POST \
"https://admin.jmanual.org/api/update-note" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-note\",
\"title\": \"example-title-note\",
\"description\": \"example-description-note\",
\"tag\": [
\"comedy\"
]
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Note Updated Successfully",
"folder": []
}
}This endpoint allows user to delete a note in a folder.
curl --request POST \
"https://admin.jmanual.org/api/delete-note" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-note\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Note Deleted Successfully",
"folder": []
}
}This endpoint allows user to duplicate a note in a folder.
curl --request POST \
"https://admin.jmanual.org/api/duplicate-note" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-note\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Note Duplicated Successfully",
"folder": []
}
}This endpoint allows user to export a note.
Provide handle of note : Required
curl --request GET \
--get "https://admin.jmanual.org/api/note-export?slug=example-handle-note" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Note Generated Successfully",
"folder": {
"url": "http://haggadot.raca.sr/exports/document_note/the-first-note1691644216.pdf"
}
}
}This endpoint is for display clips in library.
For filtering and sorting the data ,one can specify multiple value by passing a comma separated list of available property name.
Keyword to search for
Filtering the data based on media type
Available property name: text, image, video, audio
Default: all
Provide handle of tags
Provide handle of language
Sorting the resource clip
curl --request GET \
--get "https://admin.jmanual.org/api/library-clip?filter%5Bsearch%5D=example-search&filter%5Btype%5D=text&filter%5Btag%5D=weddings&filter%5Blanguage%5D=english&sort=-recent" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"clips": [
{
"clip": {
"is_admin": 1,
"is_owner": 1,
"is_bookmarked": 0,
"handle": "cccccc-1",
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title_english": "cccccc",
"title_hebrew": "",
"description_english": "This is done for testing create clip api",
"description_hebrew": "",
"personal_instruction": null,
"cliptype": "text",
"is_featured": 0,
"is_shared": 1,
"status": "published",
"language": "Hebrew",
"language_slug": "hebrew",
"media": {
"image": null,
"audio": null,
"video": null
},
"tags": [],
"position": null,
"marked_as_staged": null
}
}
],
"bookmarked_clips": [
{
"clip": {
"is_admin": 1,
"is_owner": 1,
"is_bookmarked": 1,
"handle": "cccccc",
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title_english": "cccccc",
"title_hebrew": "",
"description_english": "This is done for testing create clip api",
"description_hebrew": "",
"personal_instruction": null,
"cliptype": "text",
"is_featured": 0,
"is_shared": 1,
"status": "published",
"language": "English",
"language_slug": "english",
"media": {
"image": null,
"audio": null,
"video": null
},
"tags": [
{
"tag": "Wedding",
"slug": "wedding"
}
],
"position": null,
"marked_as_staged": null
}
}
]
},
"links": {
"first": "http://raca.haggadot.sr/api/library-clip?page=1",
"last": "http://raca.haggadot.sr/api/library-clip?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.haggadot.sr/api/library-clip?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.haggadot.sr/api/library-clip",
"per_page": 18,
"to": 1,
"total": 1,
"total_shared_resource": 0
}
}This endpoint is for display Template in library.
For filtering and sorting the data ,one can specify multiple value by passing a comma separated list of available property name.
Keyword to search for
Provide handle of template type
Provide handle of tags
Provide handle of language
Sorting the resource template
curl --request GET \
--get "https://admin.jmanual.org/api/library-template?filter%5Bsearch%5D=example-search&filter%5Btype%5D=example-handle-template-type&filter%5Btag%5D=weddings&filter%5Blanguage%5D=english&sort=-recent" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"templates": [
{
"template": {
"is_admin": 1,
"is_owner": 1,
"is_bookmarked": 0,
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title": "asfasfasdfgegrfgdfhfgfgmvsdbsdbdbsdbsdbsdbsdbsdbsdbsdbsdbsdb",
"slug": "asfasfasdfgegrfgdfhfgfgmvsdbsdbdbsdbsdbsdbsdbsdbsdbsdbsdbsdb",
"template_type": "simchat-bat",
"template_name": "Simchat Bat",
"status": "published",
"is_shared": 1,
"language": "English",
"language_slug": "english",
"tags": []
}
}
],
"bookmarked_templates": [
{
"template": {
"is_admin": 1,
"is_owner": 1,
"is_bookmarked": 1,
"author": "admin",
"author_handle": "admin",
"author_initials": "AD",
"title": "testing create template",
"slug": "testing-create-template",
"template_type": "brit-milah",
"template_name": "Brit Milah",
"status": "published",
"is_shared": 1,
"language": "Hebrew",
"language_slug": "hebrew",
"tags": []
}
}
]
},
"links": {
"first": "http://raca.haggadot.sr/api/library-template?page=1",
"last": "http://raca.haggadot.sr/api/library-template?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.haggadot.sr/api/library-template?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://raca.haggadot.sr/api/library-template",
"per_page": 18,
"to": 1,
"total": 1,
"total_shared_resource": 12
}
}This endpoint is for display documents in library.
For filtering and sorting the data ,one can specify multiple value by passing a comma separated list of available property name.
Keyword to search for
Filtering the data based on media type
Provide handle of tags
Provide handle of language
Sorting the resource document
Available property name: recent
curl --request GET \
--get "https://admin.jmanual.org/api/library-document?filter%5Bsearch%5D=example-search&filter%5Btype%5D=pdf&filter%5Btag%5D=wedding&filter%5Blanguage%5D=english&sort=-recent" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"document": [
{
"file_name": "ahe first file",
"handle": "ahe-first-file",
"url": "https://raca.us-east-1.linodeobjects.com/uploads/the first file.docx",
"is_bookmarked": 0,
"author": "admin test",
"author_handle": "admin",
"author_initials": "AT",
"is_shared": 1,
"is_archived": 0,
"uploaded_on": "2023-08-01T06:21:20.000000Z",
"language": "English",
"language_slug": "english",
"tags": [
{
"tag": "Wedding",
"slug": "wedding"
},
{
"tag": "Couple",
"slug": "couple"
}
]
}
],
"bookmarked_documents": [
{
"file_name": "the first file excel",
"handle": "the-first-file-excel-22",
"url": "https://raca.us-east-1.linodeobjects.com/assets/the_first_file_excel_22.gif",
"is_bookmarked": 1,
"author": "admin1cahnged trst",
"author_handle": "admin1cahnged-trst",
"author_initials": "AT",
"is_shared": 1,
"is_archived": 0,
"uploaded_on": "2023-08-01T07:25:50.000000Z",
"language": "English",
"language_slug": "english",
"tags": []
}
]
},
"links": {
"first": "http://haggadot.raca.sr/api/library-document?page=1",
"last": "http://haggadot.raca.sr/api/library-document?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://haggadot.raca.sr/api/library-document?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://haggadot.raca.sr/api/library-document",
"per_page": 18,
"to": 1,
"total": 1,
"total_shared_resource": 1
}
}This endpoint is for displaying library statistics.
curl --request GET \
--get "https://admin.jmanual.org/api/library-statistics" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"library": {
"total_shared_resource": 10
}
}
}This endpoint is for getting all help-center topics and featured articles along with the filter to search articles within help-center
Keyword to search for
curl --request GET \
--get "https://admin.jmanual.org/api/help-center?filter%5Bsearch%5D=example-search" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"help_center_topics": [
{
"handle": "raca-basics",
"title": "Raca.com Basics",
"description": "Learn the basics of using raca.com to make the most of your seder.",
"total_article": 13
}
],
"featured_articles": [
{
"article": {
"topic": "Our Template Recommendations",
"topic_handle": "clip-creation",
"sub_topic": "Template Recommendations",
"sub_topic_handle": "template-recommendations",
"handle": "do-can-you-help",
"title": "Can you help?",
"description": "Recommendations for Template",
"content": "<p>Of course!",
"is_featured": 1
}
}
]
}
}This endpoint is for previewing any help-center topic and articles within it.
Provide handle of the help-center topic. : Required
curl --request GET \
--get "https://admin.jmanual.org/api/help-center-topic?slug=example-handle-topic" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"help_center_topics": [
{
"handle": "template-basics",
"title": "Template.com Basics",
"description": "Learn the basics of using Template.com to make the most.",
"total_article": 13,
"details": [
{
"title": "How to Use Template.com-1",
"articles": [
{
"article": {
"topic": "Template.com Basics",
"topic_handle": "template-basics",
"sub_topic": "How to Use Template.com-1",
"sub_topic_handle": "intro-to-Templatecom-1",
"handle": "how-do-i-collaborate-with-family-friends-or-coworkers-on-creating-my-template",
"title": "How do I collaborate with family, friends or coworkers on creating my Template?",
"description": "Collaborating with others to create your Template is easy!",
"content": "account to be able to co-create and edit with you. </p>",
"is_featured": 0
}
}
]
}
]
}
]
}
}This endpoint is for previewing any help-center article and get similar articles.
Provide handle of the help-center article. : Required
curl --request GET \
--get "https://admin.jmanual.org/api/help-center-article?slug=example-handle-article" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"help_center_article": [
{
"article": {
"topic": "Template.com Basics",
"topic_handle": "template-basics",
"sub_topic": "How to Use Template.com-1",
"sub_topic_handle": "intro-to-Template-1",
"handle": "do-i-need-to-sign-in",
"title": "Do I need to sign up?",
"description": "Using the Template.com site",
"content": "<p>To use all the features offered on Template.com, you’ll need to create an account with your email address and a password. That way, you can browse our entire library of clips and Template, save a clip, create and save your own clips, and create and download your customized Template. <br />\r\n </p>",
"is_featured": 1,
"similar_articles": [
{
"handle": "how-do-i-collaborate-with-coworkers-on-creating-my-template",
"title": "How do I collaborate with coworkers on creating my Template?",
"description": "Collaborating with others to create your Template is easy!"
}
]
}
}
]
}
}This endpoint allows user to add clip to template.
curl --request POST \
"https://admin.jmanual.org/api/add-clip-template" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template\": {
\"key\": [
{
\"template_slug\": \"examp-handle-template\",
\"section_slug\": \"examp-handle-template-section\",
\"clip_slug\": \"examp-handle-clip\"
}
]
}
}"
cache-control
: no-cache, private
content-type
: application/json
access-control-allow-origin
: *
{
"message": "The route api/add-clip-template could not be found.",
"exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/AbstractRouteCollection.php",
"line": 44,
"trace": [
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/RouteCollection.php",
"line": 162,
"function": "handleMatchedRoute",
"class": "Illuminate\\Routing\\AbstractRouteCollection",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 761,
"function": "match",
"class": "Illuminate\\Routing\\RouteCollection",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 748,
"function": "findRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 737,
"function": "dispatchToRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 200,
"function": "dispatch",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 144,
"function": "Illuminate\\Foundation\\Http\\{closure}",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/livewire/livewire/src/Features/SupportDisablingBackButtonCache/DisableBackButtonCacheMiddleware.php",
"line": 19,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Livewire\\Features\\SupportDisablingBackButtonCache\\DisableBackButtonCacheMiddleware",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/barryvdh/laravel-debugbar/src/Middleware/InjectDebugbar.php",
"line": 59,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Barryvdh\\Debugbar\\Middleware\\InjectDebugbar",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
"line": 31,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
"line": 40,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
"line": 27,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
"line": 99,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
"line": 62,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\HandleCors",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
"line": 39,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\TrustProxies",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 175,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 144,
"function": "sendRequestThroughRouter",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 310,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 298,
"function": "callLaravelOrLumenRoute",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 91,
"function": "makeApiCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 44,
"function": "makeResponseCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 35,
"function": "makeResponseCallIfConditionsPass",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 236,
"function": "__invoke",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 166,
"function": "iterateThroughStrategies",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 95,
"function": "fetchResponses",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 125,
"function": "processRoute",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 72,
"function": "extractEndpointsInfoFromLaravelApp",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 50,
"function": "extractEndpointsInfoAndWriteToDisk",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
"line": 53,
"function": "get",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 36,
"function": "handle",
"class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/Util.php",
"line": 41,
"function": "Illuminate\\Container\\{closure}",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 93,
"function": "unwrapIfClosure",
"class": "Illuminate\\Container\\Util",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 37,
"function": "callBoundMethod",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/Container.php",
"line": 662,
"function": "call",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 211,
"function": "call",
"class": "Illuminate\\Container\\Container",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Command/Command.php",
"line": 326,
"function": "execute",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 181,
"function": "run",
"class": "Symfony\\Component\\Console\\Command\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 1096,
"function": "run",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 324,
"function": "doRunCommand",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 175,
"function": "doRun",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
"line": 201,
"function": "run",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/artisan",
"line": 37,
"function": "handle",
"class": "Illuminate\\Foundation\\Console\\Kernel",
"type": "->"
}
]
}This endpoint allows user to add clip to ceremony.
curl --request POST \
"https://admin.jmanual.org/api/add-clip-ceremony" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ceremony\": {
\"key\": [
{
\"ceremony_slug\": \"examp-handle-ceremony\",
\"section_slug\": \"examp-handle-ceremony-section\",
\"clip_slug\": \"examp-handle-clip\"
}
]
}
}"
cache-control
: no-cache, private
content-type
: application/json
access-control-allow-origin
: *
{
"message": "The route api/add-clip-ceremony could not be found.",
"exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/AbstractRouteCollection.php",
"line": 44,
"trace": [
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/RouteCollection.php",
"line": 162,
"function": "handleMatchedRoute",
"class": "Illuminate\\Routing\\AbstractRouteCollection",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 761,
"function": "match",
"class": "Illuminate\\Routing\\RouteCollection",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 748,
"function": "findRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 737,
"function": "dispatchToRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 200,
"function": "dispatch",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 144,
"function": "Illuminate\\Foundation\\Http\\{closure}",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/livewire/livewire/src/Features/SupportDisablingBackButtonCache/DisableBackButtonCacheMiddleware.php",
"line": 19,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Livewire\\Features\\SupportDisablingBackButtonCache\\DisableBackButtonCacheMiddleware",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/barryvdh/laravel-debugbar/src/Middleware/InjectDebugbar.php",
"line": 59,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Barryvdh\\Debugbar\\Middleware\\InjectDebugbar",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
"line": 31,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
"line": 40,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
"line": 27,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
"line": 99,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
"line": 62,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\HandleCors",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
"line": 39,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\TrustProxies",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 175,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 144,
"function": "sendRequestThroughRouter",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 310,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 298,
"function": "callLaravelOrLumenRoute",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 91,
"function": "makeApiCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 44,
"function": "makeResponseCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 35,
"function": "makeResponseCallIfConditionsPass",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 236,
"function": "__invoke",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 166,
"function": "iterateThroughStrategies",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 95,
"function": "fetchResponses",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 125,
"function": "processRoute",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 72,
"function": "extractEndpointsInfoFromLaravelApp",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 50,
"function": "extractEndpointsInfoAndWriteToDisk",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
"line": 53,
"function": "get",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 36,
"function": "handle",
"class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/Util.php",
"line": 41,
"function": "Illuminate\\Container\\{closure}",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 93,
"function": "unwrapIfClosure",
"class": "Illuminate\\Container\\Util",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 37,
"function": "callBoundMethod",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/Container.php",
"line": 662,
"function": "call",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 211,
"function": "call",
"class": "Illuminate\\Container\\Container",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Command/Command.php",
"line": 326,
"function": "execute",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 181,
"function": "run",
"class": "Symfony\\Component\\Console\\Command\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 1096,
"function": "run",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 324,
"function": "doRunCommand",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 175,
"function": "doRun",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
"line": 201,
"function": "run",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/artisan",
"line": 37,
"function": "handle",
"class": "Illuminate\\Foundation\\Console\\Kernel",
"type": "->"
}
]
}This endpoint allows user to save clips from template and ceremony.
curl --request POST \
"https://admin.jmanual.org/api/save-as-clip" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"example-handle-clip\",
\"title\": \"example-title-clip\"
}"
cache-control
: no-cache, private
content-type
: application/json
access-control-allow-origin
: *
{
"message": "The route api/save-as-clip could not be found.",
"exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/AbstractRouteCollection.php",
"line": 44,
"trace": [
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/RouteCollection.php",
"line": 162,
"function": "handleMatchedRoute",
"class": "Illuminate\\Routing\\AbstractRouteCollection",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 761,
"function": "match",
"class": "Illuminate\\Routing\\RouteCollection",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 748,
"function": "findRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
"line": 737,
"function": "dispatchToRoute",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 200,
"function": "dispatch",
"class": "Illuminate\\Routing\\Router",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 144,
"function": "Illuminate\\Foundation\\Http\\{closure}",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/livewire/livewire/src/Features/SupportDisablingBackButtonCache/DisableBackButtonCacheMiddleware.php",
"line": 19,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Livewire\\Features\\SupportDisablingBackButtonCache\\DisableBackButtonCacheMiddleware",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/barryvdh/laravel-debugbar/src/Middleware/InjectDebugbar.php",
"line": 59,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Barryvdh\\Debugbar\\Middleware\\InjectDebugbar",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
"line": 31,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
"line": 21,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
"line": 40,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
"line": 27,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
"line": 99,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
"line": 62,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\HandleCors",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
"line": 39,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 183,
"function": "handle",
"class": "Illuminate\\Http\\Middleware\\TrustProxies",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
"line": 119,
"function": "Illuminate\\Pipeline\\{closure}",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 175,
"function": "then",
"class": "Illuminate\\Pipeline\\Pipeline",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
"line": 144,
"function": "sendRequestThroughRouter",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 310,
"function": "handle",
"class": "Illuminate\\Foundation\\Http\\Kernel",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 298,
"function": "callLaravelOrLumenRoute",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 91,
"function": "makeApiCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 44,
"function": "makeResponseCall",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
"line": 35,
"function": "makeResponseCallIfConditionsPass",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 236,
"function": "__invoke",
"class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 166,
"function": "iterateThroughStrategies",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
"line": 95,
"function": "fetchResponses",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 125,
"function": "processRoute",
"class": "Knuckles\\Scribe\\Extracting\\Extractor",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 72,
"function": "extractEndpointsInfoFromLaravelApp",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
"line": 50,
"function": "extractEndpointsInfoAndWriteToDisk",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
"line": 53,
"function": "get",
"class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 36,
"function": "handle",
"class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/Util.php",
"line": 41,
"function": "Illuminate\\Container\\{closure}",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 93,
"function": "unwrapIfClosure",
"class": "Illuminate\\Container\\Util",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
"line": 37,
"function": "callBoundMethod",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Container/Container.php",
"line": 662,
"function": "call",
"class": "Illuminate\\Container\\BoundMethod",
"type": "::"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 211,
"function": "call",
"class": "Illuminate\\Container\\Container",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Command/Command.php",
"line": 326,
"function": "execute",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Console/Command.php",
"line": 181,
"function": "run",
"class": "Symfony\\Component\\Console\\Command\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 1096,
"function": "run",
"class": "Illuminate\\Console\\Command",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 324,
"function": "doRunCommand",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/symfony/console/Application.php",
"line": 175,
"function": "doRun",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
"line": 201,
"function": "run",
"class": "Symfony\\Component\\Console\\Application",
"type": "->"
},
{
"file": "/home/sphere5/sphere5/code/racabackend/artisan",
"line": 37,
"function": "handle",
"class": "Illuminate\\Foundation\\Console\\Kernel",
"type": "->"
}
]
}This endpoint allows search on Sefaria API.
The search term to search on Sefaria : Required
curl --request GET \
--get "https://admin.jmanual.org/api/sefaria-api?term=passover" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": "200",
"message": "Successful",
"sefaria_data": [
{
"title": "Jerusalem Talmud Nedarim 7:9:1",
"details": "The Jerusalem Talmud, translation and commentary by Heinrich W. Guggenheimer. Berlin, De Gruyter, 1999-2015 [en])",
"content": [
"MISHNAH: ‘What you prepare until <b>Passover</b> I would eat what you make until <b>Passover</b> I would wear if she made before <b>Passover</b>, he is forbidden to eat or wear after <b>Passover</b>."
]
}
]
},
"links": {
"first": "http://raca.sr/api/sefaria-api?term=passover&page=1",
"last": "http://raca.sr/api/sefaria-api?term=passover&page=28",
"prev": null,
"next": "http://raca.sr/api/sefaria-api?term=passover&page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 28,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://raca.sr/api/sefaria-api?term=passover&page=1",
"label": "1",
"active": true
},
{
"url": "http://raca.sr/api/sefaria-api?term=passover&page=2",
"label": "2",
"active": false
},
{
"url": "http://raca.sr/api/sefaria-api?term=passover&page=3",
"label": "3",
"active": false
},
{
"url": "http://raca.sr/api/sefaria-api?term=passover&page=10",
"label": "10",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "http://raca.sr/api/sefaria-api?term=passover&page=27",
"label": "27",
"active": false
},
{
"url": "http://raca.sr/api/sefaria-api?term=passover&page=28",
"label": "28",
"active": false
},
{
"url": "http://raca.sr/api/sefaria-api?term=passover&page=2",
"label": "Next »",
"active": false
}
],
"path": "http://raca.sr/api/sefaria-api",
"per_page": 18,
"to": 18,
"total": 500
}
}This endpoint allows to search for clips based on appropriate filters.
For filtering ,one can specify multiple value by passing a comma separated list of available property name.
Active Tab : Required
Available values: bookmark = Bookmarked Tab, library = Library Tab
Please Note: No parameters are required for 'My Clips' Tab
Handle of the tag for filtering : Required
curl --request GET \
--get "https://admin.jmanual.org/api/clip-slider?tab=bookmark&filter%5Btag%5D=example-handle-tag" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"This endpoint is to maintain modal popup status.
curl --request POST \
"https://admin.jmanual.org/api/display-modal" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resource\": \"template\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Successful",
"user": [
{
"details": {
"handle": "admin",
"email": "[email protected]",
"first_name": "admin",
"middle_name": null,
"last_name": "",
"full_name": "admin",
"author_initials": "AD",
"bio": null,
"image": null,
"display_modal_template": 0,
"display_modal_ceremony": 1
}
}
]
}
}This endpoint allows to get embedded media information.
curl --request POST \
"https://admin.jmanual.org/api/embedded-media" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"url\": \"example-url\"
}"
This endpoint is for reporting any bug.
Provide section-slug from global response : Required
Provide action-type : Required
Available value: add, edit, delete
Provide description of bug : Required
Provide with base64 encoded image : Required
curl --request POST \
"https://admin.jmanual.org/api/store-bug?section=dashboard&action_type=add&describe_bug=This+is+the+reposrt+bug&bug_image=data%3Aimage%2Fpng%3Bbase64%2CiVBOR.....................................FAAAAABJRU5ErkJggg%3D%3D" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"data": {
"success": true,
"status_code": 200,
"message": "Bug Reported Succesfully",
"bug": []
}
}This endpoint is for retrieving image url for uploaded base64 encoded image.
curl --request POST \
"https://admin.jmanual.org/api/upload-media" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"image\": \"data:image\\/png;base64,iVBOR.....................................FAAAAABJRU5ErkJggg==\"
}"
{
"data": {
"success": true,
"status_code": 200,
"message": "Image uploaded successfully",
"image": {
"url": "https://raca.us-east-1.linodeobjects.com/temp_api_images/1684996768.jpeg"
}
}
}