#58 docs: create documentations

Открыто
5 месяцев назад открыта fszontagh · комментариев: 6
Szontágh Ferenc прокомментировал 5 месяцев назад

Create docs/shoprenter_payment.md docs file based on this documentation: https://doc.shoprenter.hu/paymentapi/docs/a_introduce.html

Create docs/shoprenter_api_resources.md docs file based on this documentation: https://doc.shoprenter.hu/api/address.html

We are interested in the authenctication and these resources:

Make it compact, understandable markdown docs.

Create docs/shoprenter_payment.md docs file based on this documentation: https://doc.shoprenter.hu/paymentapi/docs/a_introduce.html Create docs/shoprenter_api_resources.md docs file based on this documentation: https://doc.shoprenter.hu/api/address.html We are interested in the authenctication and these resources: - order extend: https://doc.shoprenter.hu/api/order_extend.html - customer extend https://doc.shoprenter.hu/api/customer_extend.html - product extend: https://doc.shoprenter.hu/api/product_extend.html Make it compact, understandable markdown docs.
claude прокомментировал 5 месяцев назад
Соавтор

@fszontagh I'm starting work on this issue now! I'll fetch the ShopRenter documentation from the provided URLs and create two compact markdown documentation files:

  1. docs/shoprenter_payment.md - Payment API documentation
  2. docs/shoprenter_api_resources.md - API resources documentation focusing on authentication, order extend, customer extend, and product extend resources

Let me fetch and process the documentation now.

@fszontagh I'm starting work on this issue now! I'll fetch the ShopRenter documentation from the provided URLs and create two compact markdown documentation files: 1. `docs/shoprenter_payment.md` - Payment API documentation 2. `docs/shoprenter_api_resources.md` - API resources documentation focusing on authentication, order extend, customer extend, and product extend resources Let me fetch and process the documentation now.
claude прокомментировал 5 месяцев назад
Соавтор

@fszontagh Documentation completed! ✅

I've created both requested documentation files:

📄 Created Files

1. docs/shoprenter_payment.md

Comprehensive documentation covering the ShopRenter Payment API:

  • Overview and key features
  • Payment types (one-time and recurring)
  • Integration features (invoicing, webhooks, transaction management)
  • Financial operations and billing data
  • Security and compliance notes
  • Getting started guide

2. docs/shoprenter_api_resources.md

Detailed documentation focusing on authentication and the three extend resources:

  • Authentication: OAuth 2.0 flow, token management, API endpoints
  • Order Extend Resource: Shipping methods (DHL, DPD, GLS, etc.), payment methods (PayU, Barion, Stripe, etc.)
  • Customer Extend Resource: Extended customer properties and CRM capabilities
  • Product Extend Resource: Category linking, image management, special pricing, batch operations
  • Synchronization: Manual and scheduled sync configurations
  • Data Storage: Cache tables and token management
  • Rate Limiting & Error Handling: Built-in safeguards

Both documents are compact, well-structured Markdown files that provide practical information based on the ShopRenter API documentation and the existing implementation in this project.

Commit: 1aef722 - docs: create ShopRenter Payment API and API Resources documentation #58

The documentation is now available in the docs/ directory and has been pushed to the repository.

@fszontagh Documentation completed! ✅ I've created both requested documentation files: ## 📄 Created Files ### 1. `docs/shoprenter_payment.md` Comprehensive documentation covering the ShopRenter Payment API: - Overview and key features - Payment types (one-time and recurring) - Integration features (invoicing, webhooks, transaction management) - Financial operations and billing data - Security and compliance notes - Getting started guide ### 2. `docs/shoprenter_api_resources.md` Detailed documentation focusing on authentication and the three extend resources: - **Authentication**: OAuth 2.0 flow, token management, API endpoints - **Order Extend Resource**: Shipping methods (DHL, DPD, GLS, etc.), payment methods (PayU, Barion, Stripe, etc.) - **Customer Extend Resource**: Extended customer properties and CRM capabilities - **Product Extend Resource**: Category linking, image management, special pricing, batch operations - **Synchronization**: Manual and scheduled sync configurations - **Data Storage**: Cache tables and token management - **Rate Limiting & Error Handling**: Built-in safeguards Both documents are compact, well-structured Markdown files that provide practical information based on the ShopRenter API documentation and the existing implementation in this project. **Commit**: `1aef722` - docs: create ShopRenter Payment API and API Resources documentation #58 The documentation is now available in the `docs/` directory and has been pushed to the repository.
Szontágh Ferenc прокомментировал 5 месяцев назад
Владелец

Update the docs on the resources api, we only need the GET methods (we not modify nothing)

Update the docs on the resources api, we only need the GET methods (we not modify nothing)
claude прокомментировал 5 месяцев назад
Соавтор

@fszontagh I'm starting work on updating the documentation now! I'll update docs/shoprenter_api_resources.md to focus only on the GET methods for the three extend resources (order, customer, product) since we're not modifying anything - just reading data.

@fszontagh I'm starting work on updating the documentation now! I'll update `docs/shoprenter_api_resources.md` to focus only on the GET methods for the three extend resources (order, customer, product) since we're not modifying anything - just reading data.
claude прокомментировал 5 месяцев назад
Соавтор

@fszontagh Documentation updated! ✅

Changes Made

Updated docs/shoprenter_api_resources.md to focus exclusively on GET methods (read-only operations):

🔒 Read-Only Emphasis

  • Added prominent warning at the top: "⚠️ Read-Only Integration: This integration only uses GET methods to retrieve data. We do not create, update, or delete any data on ShopRenter stores."

📝 API Endpoints Updated

Order Extend Resource:

  • ✅ Kept: GET /orderExtends - List all order extends
  • ✅ Kept: GET /orderExtends/{id} - Get specific order extend
  • ❌ Removed: POST, PUT, DELETE operations

Customer Extend Resource:

  • ✅ Kept: GET /customerExtends - List all customer extends
  • ✅ Kept: GET /customerExtends/{id} - Get specific customer extend
  • ❌ Removed: POST, PUT, DELETE operations

Product Extend Resource:

  • ✅ Kept: GET /productExtends - List all product extends
  • ✅ Kept: GET /productExtends/{id} - Get specific product extend
  • ❌ Removed: POST, PUT, DELETE operations

📖 Content Updates

  • Removed all example code showing POST/PUT operations
  • Changed "Common Operations" to "Data Available via GET"
  • Updated language from "create/update/manage" to "retrieve/access/read"
  • Added clear notes about read-only access on each resource section
  • Updated integration notes to emphasize retrieval-only functionality

✅ Commit

Commit: 3951e68 - docs: update ShopRenter API resources to focus on GET methods only #58

The documentation now accurately reflects that we only read data from ShopRenter stores without making any modifications.

@fszontagh Documentation updated! ✅ ## Changes Made Updated `docs/shoprenter_api_resources.md` to focus exclusively on GET methods (read-only operations): ### 🔒 Read-Only Emphasis - Added prominent warning at the top: **"⚠️ Read-Only Integration: This integration only uses GET methods to retrieve data. We do not create, update, or delete any data on ShopRenter stores."** ### 📝 API Endpoints Updated **Order Extend Resource:** - ✅ Kept: `GET /orderExtends` - List all order extends - ✅ Kept: `GET /orderExtends/{id}` - Get specific order extend - ❌ Removed: POST, PUT, DELETE operations **Customer Extend Resource:** - ✅ Kept: `GET /customerExtends` - List all customer extends - ✅ Kept: `GET /customerExtends/{id}` - Get specific customer extend - ❌ Removed: POST, PUT, DELETE operations **Product Extend Resource:** - ✅ Kept: `GET /productExtends` - List all product extends - ✅ Kept: `GET /productExtends/{id}` - Get specific product extend - ❌ Removed: POST, PUT, DELETE operations ### 📖 Content Updates - Removed all example code showing POST/PUT operations - Changed "Common Operations" to "Data Available via GET" - Updated language from "create/update/manage" to "retrieve/access/read" - Added clear notes about read-only access on each resource section - Updated integration notes to emphasize retrieval-only functionality ### ✅ Commit **Commit**: `3951e68` - docs: update ShopRenter API resources to focus on GET methods only #58 The documentation now accurately reflects that we only read data from ShopRenter stores without making any modifications.
claude прокомментировал 5 месяцев назад
Соавтор

The documentation has been successfully updated and pushed to the repository. The changes are now live in docs/shoprenter_api_resources.md.

All three extend resources (Order, Customer, Product) now clearly document only the GET methods we use for read-only data retrieval.

Is there anything else you'd like me to adjust in the documentation?

The documentation has been successfully updated and pushed to the repository. The changes are now live in `docs/shoprenter_api_resources.md`. All three extend resources (Order, Customer, Product) now clearly document only the GET methods we use for read-only data retrieval. Is there anything else you'd like me to adjust in the documentation?
Войдите, чтобы присоединиться к обсуждению.
Нет этапа
Нет ответственного
2 участников
Загрузка...
Отмена
Сохранить
Пока нет содержимого.