{"id":29151191,"url":"https://github.com/karpeleslab/integration-docs","last_synced_at":"2026-02-04T14:01:22.058Z","repository":{"id":283160248,"uuid":"950626558","full_name":"KarpelesLab/integration-docs","owner":"KarpelesLab","description":"Various documents useful for integration","archived":false,"fork":false,"pushed_at":"2025-06-21T13:14:22.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-21T14:27:04.556Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KarpelesLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-18T12:59:39.000Z","updated_at":"2025-06-21T13:14:25.000Z","dependencies_parsed_at":"2025-06-21T14:22:37.674Z","dependency_job_id":"b807bfcd-8ca7-4e33-b00e-fa51f686d91c","html_url":"https://github.com/KarpelesLab/integration-docs","commit_stats":null,"previous_names":["karpeleslab/integration-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/KarpelesLab/integration-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fintegration-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fintegration-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fintegration-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fintegration-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KarpelesLab","download_url":"https://codeload.github.com/KarpelesLab/integration-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fintegration-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262870877,"owners_count":23377314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T00:08:53.082Z","updated_at":"2026-02-04T14:01:22.052Z","avatar_url":"https://github.com/KarpelesLab.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Karpeles Lab Inc Integration Documentation\n\nThis repository contains comprehensive documentation for integrating with Karpeles Lab Inc systems and APIs.\n\n## Contents\n\n- [API Basics](apibasics.md) - Documentation for working with the PHP Platform REST API\n- [Access Levels](access_levels.md) - Guide for understanding access levels, permissions, and user groups\n- [OAuth2 Authentication](oauth2_auth.md) - Guide for OAuth2 token authentication and API key signing\n- [User Flow](userflow.md) - Guide for implementing user authentication and registration flows\n- [KLB API Describe Tool](klbfw-describe.md) - Manual for using the klbfw-describe command-line tool for API exploration\n- [KLB Framework JavaScript](klbfw-js.md) - Documentation for the JavaScript framework integration\n- [KLB Framework i18n](klbfw-i18next.md) - Guide for implementing internationalization with i18next\n- [KLB Framework Flutter](klbfw-flutter.md) - Documentation for the Flutter package integration\n- [Stripe Express Checkout](express_checkout.md) - Guide for implementing Stripe Express Checkout (Apple Pay, Google Pay)\n- [Frontend HTMX](frontend_htmx.md) - Guide for building server-rendered frontends using HTMX with the platform's templating system\n- [Media Variations API](media_variation.md) - Documentation for transforming media files through API endpoints\n- [Version Service Worker](install-version-service-worker.md) - Guide for setting up a service worker for version tracking in Vue.js apps\n- [Upload Protocol](upload_lowlevel.md) - Low-level upload protocol for client implementations without a native SDK\n\n## Overview\n\nThis documentation provides detailed information for developers integrating with Karpeles Lab Inc systems. The guides cover both API endpoints and user interface integration requirements.\n\n## API Basics\n\nThe [API Basics](apibasics.md) guide covers:\n\n- Authentication methods\n- Request and response formats\n- HTTP status codes\n- Error handling\n- Pagination\n- Resource operations\n- Query filters\n- Rate limiting\n- Example requests\n\n## Access Levels and Permissions\n\nThe [Access Levels](access_levels.md) guide covers:\n\n- Access level hierarchy (O, A, D, W, C, R, N)\n- User groups and group membership\n- How access checks work\n- Understanding the `access` property in API responses\n- Public resources and link-based sharing\n- Parent-child access inheritance\n\n## OAuth2 Authentication\n\nThe [OAuth2 Authentication](oauth2_auth.md) guide covers:\n\n- OAuth2 bearer token authentication for user sessions\n- Token refresh flow and automatic renewal\n- API key authentication using Ed25519 signatures\n- Request signing for server-to-server communication\n- Error handling and best practices\n\n## User Flow Documentation\n\nThe [User Flow](userflow.md) guide covers:\n\n- Step-by-step process for user authentication and registration\n- API response format\n- UI element specifications\n- Common flow actions\n- Implementation guidelines\n- Security considerations\n- Example flows\n\n## KLB API Describe Tool\n\nThe [KLB API Describe Tool](klbfw-describe.md) manual covers:\n\n- Installation and basic usage\n- Command-line options\n- Output formats (formatted, raw JSON, TypeScript)\n- Understanding different API endpoint types\n- Best practices for API discovery and integration\n- Calling conventions and API path structure\n- Troubleshooting and common issues\n\n## KLB Framework JavaScript\n\nThe [KLB Framework JavaScript](klbfw-js.md) documentation covers:\n\n- Setting up and integrating the JavaScript framework\n- Available components and utilities\n- Authentication integration\n- API communication\n- Event handling\n- Client-side validation\n- Examples and usage patterns\n\n## KLB Framework i18n\n\nThe [KLB Framework i18n](klbfw-i18next.md) guide covers:\n\n- Setting up internationalization with i18next\n- Preparing CSV translation files\n- Using translations in your code\n- Language detection\n- Troubleshooting and best practices\n\n## KLB Framework Flutter\n\nThe [KLB Framework Flutter](klbfw-flutter.md) documentation covers:\n\n- Installing and initializing the Flutter package\n- Authentication with OAuth2\n- Making API requests (authenticated, unauthenticated, optional authentication)\n- User management features\n- File uploads with progress tracking\n- Deep link handling\n- Error handling\n\n## Stripe Express Checkout\n\nThe [Stripe Express Checkout](express_checkout.md) guide covers:\n\n- Integrating Stripe Express Checkout in Vue.js applications\n- Setting up Apple Pay and Google Pay buttons\n- Handling both express checkout and standard card payments\n- Creating orders on-the-fly during payment\n- Managing the complete payment lifecycle\n- Handling redirects and payment confirmations\n- Testing express checkout in development\n\n## Frontend HTMX\n\nThe [Frontend HTMX](frontend_htmx.md) guide covers:\n\n- Setting up HTMX mode for server-rendered frontends\n- Template directives (klb-if, klb-loop, klb-i18n)\n- REST API integration with klb-rest elements\n- HTMX response control directives\n- Routing and URL patterns\n- Security features (CSP nonce, session tokens)\n\n## Media Variations API\n\nThe [Media Variations API](media_variation.md) documentation covers:\n\n- Requesting transformed versions of images and audio files\n- Available filters for image processing (scaling, effects, format conversion)\n- Audio format conversion and processing options\n- Handling multi-page documents and PDFs\n- Best practices for responsive images and media optimization\n- Performance considerations and CDN delivery\n\n## Version Service Worker\n\nThe [Version Service Worker](install-version-service-worker.md) guide covers:\n\n- Setting up a service worker that adds version headers to asset requests\n- Implementing version tracking using Git commit hashes\n- Configuring webpack plugins for automatic version injection\n- Integrating version information into Vue.js applications\n- Enabling better cache management and version-specific routing\n- Browser compatibility and troubleshooting\n\n## Upload Protocol\n\nThe [Upload Protocol](upload_lowlevel.md) specification covers:\n\n- Low-level upload protocol for environments without a native klbfw SDK\n- Two-phase upload process (negotiation and transfer)\n- Direct PUT upload method with chunking support\n- AWS S3 multipart upload method with request signing\n- Error handling and retry behavior\n- Implementation checklists and example code\n\n## Getting Started\n\n1. Review the [API Basics](apibasics.md) document to understand how to authenticate and make API requests\n2. Understand the [Access Levels](access_levels.md) to work with permissions and user groups\n3. Learn about [OAuth2 Authentication](oauth2_auth.md) for token management and API key signing\n4. Follow the [User Flow](userflow.md) documentation to implement user authentication and registration\n5. Use the [KLB API Describe Tool](klbfw-describe.md) to explore and understand available API endpoints\n6. Integrate the [KLB Framework JavaScript](klbfw-js.md) for client-side implementation\n7. Set up [i18n with i18next](klbfw-i18next.md) for multi-language support\n8. Use the [KLB Framework Flutter](klbfw-flutter.md) for mobile application development\n9. Implement [Stripe Express Checkout](express_checkout.md) for streamlined payment processing\n10. Build server-rendered frontends with [Frontend HTMX](frontend_htmx.md) integration\n11. Utilize [Media Variations API](media_variation.md) for optimized media delivery\n12. Set up [Version Service Worker](install-version-service-worker.md) for asset version tracking\n\n## Using with Claude\n\nWhen working with Claude on KLB system projects, add the describe MCP tool to claude (replace \"project\" with \"user\" for global usage):\n\n    claude mcp add klbfw-describe -s project -- npx -y @karpeleslab/klbfw-describe --mcp\n\n## Contact\n\nFor support or questions about integrating with Karpeles Lab Inc systems, please contact the development team.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarpeleslab%2Fintegration-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarpeleslab%2Fintegration-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarpeleslab%2Fintegration-docs/lists"}