# U-KOMI API

> API documentation for U-KOMI app

## Rate limiting

Requests exceeding 1 request per second per IP address may be rate limited. Rate-limited requests return `429 Too Many Requests`.
. Base URL: https://api.u-komi.com

The full machine-readable specification is available as OpenAPI 3:

- [OpenAPI (English, JSON)](/openapi.en.json)
- [OpenAPI (English, YAML)](/openapi.en.yaml)
- [OpenAPI (日本語, JSON)](/openapi.ja.json)
- [OpenAPI (日本語, YAML)](/openapi.ja.yaml)

## Endpoints

- POST /visual_ugc/{API_KEY}/albums: Retrieve all albums ([docs](/en/#operation/visualUgcAlbums))
- POST /visual_ugc/{API_KEY}/albums/{album_id}/media: Retrieve all media in an album ([docs](/en/#operation/visualUgcAlbumMedia))
- POST /visual_ugc/{API_KEY}/galleries: Retrieve all galleries ([docs](/en/#operation/visualUgcGalleries))
- POST /auth/access_token: Get access token ([docs](/en/#operation/access_token))
- POST /account/{API_KEY}/view_basic: Retrieve account details ([docs](/en/#operation/account_basic))
- GET /reviews/{API_KEY}/view: Retrieve all reviews ([docs](/en/#operation/allreview))
- GET /reviews/{API_KEY}/view_basic: Retrieve all reviews ([docs](/en/#operation/view_basic))
- POST /reviews/{API_KEY}/review_with_orders: Retrieve all reviews with orders ([docs](/en/#operation/all-reviews-with-order))
- POST /reviews/{API_KEY}/groups_review_summary: Retrieve review summary for given groups ([docs](/en/#operation/groups-review-summary))
- POST /reviews/{API_KEY}/customers_review_summary: Retrieve review summary for given customer id ([docs](/en/#operation/customers-review-summary))
- POST /reviews/{API_KEY}/{review_type}/filtered_review_summary: Retrieve filtered review summary ([docs](/en/#operation/filtered_review_summary))
- GET /reviews/{API_KEY}/{review_type}/review_summary: Retrieve review summary ([docs](/en/#operation/review_by_review_type))
- GET /reviews/{API_KEY}/{review_id}/review: Retrieve selected review ([docs](/en/#operation/review_by_id))
- GET /reviews/{API_KEY}/{product_id}/product: Retrieve reviews of selected products ([docs](/en/#operation/product/review))
- POST /inline_review_form_token/{API_KEY}/get: Get inline review form token from U-KOMI system ([docs](/en/#operation/inline-review-form-token))
- POST /products/{API_KEY}/view: Retrieve Products ([docs](/en/#operation/products/retrieve))
- POST /products/{API_KEY}/view_basic: Retrieve Products ([docs](/en/#operation/products/retrieve/basic))
- POST /products/{API_KEY}/product: Retrieve product details by product ID ([docs](/en/#operation/products/retrieve/single))
- POST /products/{API_KEY}/create: Create product in U-KOMI system ([docs](/en/#operation/products/create))
- GET /products/{API_KEY}/{product_id}/{group_status}/review_summary: get product review summary ([docs](/en/#operation/review_summary))
- GET /products/{API_KEY}/{product_id}/{review_code}/review_meta: get review title and description in og:title and og:description meta tags for given review_code and product_id ([docs](/en/#operation/review_meta))
- POST /blacklist_products/{API_KEY}/view: Retrieve Blacklisted Products ([docs](/en/#operation/blacklisted_products/retrieve))
- POST /blacklist_products/{API_KEY}/create: Add blacklist product in U-KOMI system ([docs](/en/#operation/blacklisted_products/create))
- POST /blacklist_products/{API_KEY}/delete: Delete blacklist product in U-KOMI system ([docs](/en/#operation/blacklisted_products/delete))
- POST /orders/{API_KEY}/: Retrieve Orders ([docs](/en/#operation/order/retrieve))
- POST /orders/{API_KEY}/create: Create order in U-KOMI system ([docs](/en/#operation/orders/create))
- POST /orders/{API_KEY}/cancel: Cancel order in U-KOMI system ([docs](/en/#operation/orders/cancel))
- POST /groups/{API_KEY}/: Retrieve all groups of account ([docs](/en/#operation/retrieve))
- POST /groups/{API_KEY}/create: Create group in U-KOMI system ([docs](/en/#operation/groups/create))
- POST /groups/{API_KEY}/products: Add/ Remove Products form groups in U-KOMI system ([docs](/en/#operation/manage/product))
- POST /groups/{API_KEY}/view: Retrieve products for specific group ([docs](/en/#operation/group/view))
- POST /groups/{API_KEY}/delete: Delete a group ([docs](/en/#operation/groups/delete))
- GET /questions/{API_KEY}: Retrieve all Question and Answer ([docs](/en/#operation/allquestion))
- GET /questions/{API_KEY}/{product_id}: Retrieve selected question base on product id ([docs](/en/#operation/questions))
- GET /questions/{API_KEY}/{product_id}/count: Retrieve question count base on product id ([docs](/en/#operation/questions_count))
- GET /reviews/{API_KEY}/{review_id}/review_basic: Retrieve selected review (basic) ([docs](/en/#operation/review_by_id_basic))
- GET /reviews/{API_KEY}/{product_id}/product_basic: Retrieve reviews of selected product (basic) ([docs](/en/#operation/product_review_basic))
- POST /reviews/{API_KEY}/review_with_orders_basic: Retrieve reviews with order details (basic) ([docs](/en/#operation/review_with_orders_basic))
- POST /reviews/{API_KEY}/{review_id}/like: Like or dislike a review ([docs](/en/#operation/review_like))
- GET /reviews/{API_KEY}/{review_id}/likes: Retrieve like count for a review ([docs](/en/#operation/review_likes))
- GET /reviews/{API_KEY}/likes: Retrieve like counts for multiple reviews ([docs](/en/#operation/reviews_likes_batch))
- GET /questions/{API_KEY}/all_questions_basic: Retrieve all questions and answers (basic) ([docs](/en/#operation/all_questions_basic))
- GET /questions/{API_KEY}/{product_id}/questions_basic: Retrieve questions of a product (basic) ([docs](/en/#operation/product_questions_basic))
- POST /questions/{API_KEY}/{question_id}/like: Like or dislike a question ([docs](/en/#operation/question_like))
- GET /questions/{API_KEY}/{question_id}/likes: Retrieve like count for a question ([docs](/en/#operation/question_likes))
- GET /questions/{API_KEY}/likes: Retrieve like counts for multiple questions ([docs](/en/#operation/questions_likes_batch))
- POST /v1/{API_KEY}/review_form_fields: Retrieve review form fields ([docs](/en/#operation/review_form_fields))
- POST /v1/{API_KEY}/review_submit: Submit a review ([docs](/en/#operation/review_submit))
- POST /orders/{API_KEY}/customer_order: Retrieve a customer's orders ([docs](/en/#operation/customer_order))
- GET /store_badges/{API_KEY}/view: Retrieve store badges ([docs](/en/#operation/store_badges_view))
- GET /faqs/{API_KEY}: Retrieve published FAQs ([docs](/en/#operation/faqs_view))