@cmarket/partner-sdk 41.0.0 β 42.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/api/embed-api.ts +5 -5
- package/api/oauth-api.ts +1 -1
- package/api/partner-api-api.ts +1 -1
- package/api/products-api.ts +1 -1
- package/api/webhooks-api.ts +1 -1
- package/api/well-known-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/embed-api.d.ts +5 -5
- package/dist/api/embed-api.js +5 -5
- package/dist/api/oauth-api.d.ts +1 -1
- package/dist/api/oauth-api.js +1 -1
- package/dist/api/partner-api-api.d.ts +1 -1
- package/dist/api/partner-api-api.js +1 -1
- package/dist/api/products-api.d.ts +1 -1
- package/dist/api/products-api.js +1 -1
- package/dist/api/webhooks-api.d.ts +1 -1
- package/dist/api/webhooks-api.js +1 -1
- package/dist/api/well-known-api.d.ts +1 -1
- package/dist/api/well-known-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/embed-api.d.ts +5 -5
- package/dist/esm/api/embed-api.js +5 -5
- package/dist/esm/api/oauth-api.d.ts +1 -1
- package/dist/esm/api/oauth-api.js +1 -1
- package/dist/esm/api/partner-api-api.d.ts +1 -1
- package/dist/esm/api/partner-api-api.js +1 -1
- package/dist/esm/api/products-api.d.ts +1 -1
- package/dist/esm/api/products-api.js +1 -1
- package/dist/esm/api/webhooks-api.d.ts +1 -1
- package/dist/esm/api/webhooks-api.js +1 -1
- package/dist/esm/api/well-known-api.d.ts +1 -1
- package/dist/esm/api/well-known-api.js +1 -1
- package/dist/esm/api.d.ts +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/esm/models/acceptance-result-response-dto.js +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.js +1 -1
- package/dist/esm/models/api-catalog-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-dto.js +1 -1
- package/dist/esm/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-entry-dto.js +1 -1
- package/dist/esm/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-link-dto.js +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.js +1 -1
- package/dist/esm/models/award-method-public.d.ts +1 -1
- package/dist/esm/models/award-method-public.js +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.js +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/esm/models/bid-acceptance-dto.js +1 -1
- package/dist/esm/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/esm/models/bid-attachment-input-dto.js +1 -1
- package/dist/esm/models/bid-bond-dto.d.ts +1 -1
- package/dist/esm/models/bid-bond-dto.js +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.js +1 -1
- package/dist/esm/models/bid-contact-dto.d.ts +1 -1
- package/dist/esm/models/bid-contact-dto.js +1 -1
- package/dist/esm/models/bid-contacts-dto.d.ts +1 -1
- package/dist/esm/models/bid-contacts-dto.js +1 -1
- package/dist/esm/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-contract-document-dto.js +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.js +1 -1
- package/dist/esm/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-detail-response-dto.js +1 -1
- package/dist/esm/models/bid-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-document-dto.js +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-item-dto.js +1 -1
- package/dist/esm/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/esm/models/bid-lifecycle-dto.js +1 -1
- package/dist/esm/models/bid-manager-dto.d.ts +1 -1
- package/dist/esm/models/bid-manager-dto.js +1 -1
- package/dist/esm/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-payment-terms-dto.js +1 -1
- package/dist/esm/models/bid-product-dto.d.ts +1 -1
- package/dist/esm/models/bid-product-dto.js +1 -1
- package/dist/esm/models/bid-public-status.d.ts +1 -1
- package/dist/esm/models/bid-public-status.js +1 -1
- package/dist/esm/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-registered-response-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-dto.js +1 -1
- package/dist/esm/models/bid-results-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-results-response-dto.js +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.js +1 -1
- package/dist/esm/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-response-dto.js +1 -1
- package/dist/esm/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-statement-response-dto.js +1 -1
- package/dist/esm/models/bid-summary-dto.d.ts +1 -1
- package/dist/esm/models/bid-summary-dto.js +1 -1
- package/dist/esm/models/bid-type-public.d.ts +1 -1
- package/dist/esm/models/bid-type-public.js +1 -1
- package/dist/esm/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-updated-response-dto.js +1 -1
- package/dist/esm/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/cancel-bid-request-dto.js +1 -1
- package/dist/esm/models/cancel-bid200-response.d.ts +1 -1
- package/dist/esm/models/cancel-bid200-response.js +1 -1
- package/dist/esm/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/esm/models/card-payment-request-response-dto.js +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.js +1 -1
- package/dist/esm/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/esm/models/complete-acceptance200-response.js +1 -1
- package/dist/esm/models/complete-invoice200-response.d.ts +1 -1
- package/dist/esm/models/complete-invoice200-response.js +1 -1
- package/dist/esm/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-upload-request-dto.js +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/esm/models/create-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/create-bid-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-dto.js +1 -1
- package/dist/esm/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment200-response.d.ts +1 -1
- package/dist/esm/models/create-card-payment200-response.js +1 -1
- package/dist/esm/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/esm/models/create-embed-launch201-response.js +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/esm/models/create-file-upload-url201-response.js +1 -1
- package/dist/esm/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/esm/models/create-upload-url-request-dto.js +1 -1
- package/dist/esm/models/create-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/esm/models/create-webhook-endpoint-request-dto.js +1 -1
- package/dist/esm/models/create-webhook-endpoint201-response.d.ts +1 -1
- package/dist/esm/models/create-webhook-endpoint201-response.js +1 -1
- package/dist/esm/models/delivery-date-type-public.d.ts +1 -1
- package/dist/esm/models/delivery-date-type-public.js +1 -1
- package/dist/esm/models/delivery-method-public.d.ts +1 -1
- package/dist/esm/models/delivery-method-public.js +1 -1
- package/dist/esm/models/embed-bid-prefill-dto.d.ts +1 -5
- package/dist/esm/models/embed-bid-prefill-dto.js +1 -1
- package/dist/esm/models/embed-bid-prefill-item-dto.d.ts +1 -1
- package/dist/esm/models/embed-bid-prefill-item-dto.js +1 -1
- package/dist/esm/models/embed-bid-prefill-manager-dto.d.ts +1 -1
- package/dist/esm/models/embed-bid-prefill-manager-dto.js +1 -1
- package/dist/esm/models/embed-launch-request-dto.d.ts +5 -5
- package/dist/esm/models/embed-launch-request-dto.js +1 -1
- package/dist/esm/models/embed-launch-response-dto.d.ts +1 -1
- package/dist/esm/models/embed-launch-response-dto.js +1 -1
- package/dist/esm/models/excellent-procurement-public.d.ts +1 -1
- package/dist/esm/models/excellent-procurement-public.js +1 -1
- package/dist/esm/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-document-item-dto.js +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/external-contract-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-item-dto.js +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.js +1 -1
- package/dist/esm/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/esm/models/external-document-inputs-dto.js +1 -1
- package/dist/esm/models/file-meta-response-dto.d.ts +1 -1
- package/dist/esm/models/file-meta-response-dto.js +1 -1
- package/dist/esm/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/esm/models/file-uploaded-response-dto.js +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.js +1 -1
- package/dist/esm/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-settlement200-response.js +1 -1
- package/dist/esm/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-statement200-response.js +1 -1
- package/dist/esm/models/get-bid200-response.d.ts +1 -1
- package/dist/esm/models/get-bid200-response.js +1 -1
- package/dist/esm/models/get-file-meta200-response.d.ts +1 -1
- package/dist/esm/models/get-file-meta200-response.js +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/esm/models/get-webhook-endpoint200-response.d.ts +1 -1
- package/dist/esm/models/get-webhook-endpoint200-response.js +1 -1
- package/dist/esm/models/green-product-public.d.ts +1 -1
- package/dist/esm/models/green-product-public.js +1 -1
- package/dist/esm/models/health-controller-check200-response.d.ts +1 -1
- package/dist/esm/models/health-controller-check200-response.js +1 -1
- package/dist/esm/models/health-response-dto.d.ts +1 -1
- package/dist/esm/models/health-response-dto.js +1 -1
- package/dist/esm/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/esm/models/hierarchical-region-dto.js +1 -1
- package/dist/esm/models/introspect-request-dto.d.ts +1 -1
- package/dist/esm/models/introspect-request-dto.js +1 -1
- package/dist/esm/models/introspection-response-dto.d.ts +1 -1
- package/dist/esm/models/introspection-response-dto.js +1 -1
- package/dist/esm/models/invalid-param-dto.d.ts +1 -1
- package/dist/esm/models/invalid-param-dto.js +1 -1
- package/dist/esm/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-completed-response-dto.js +1 -1
- package/dist/esm/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-split-response-dto.js +1 -1
- package/dist/esm/models/legal-mandatory-public.d.ts +1 -1
- package/dist/esm/models/legal-mandatory-public.js +1 -1
- package/dist/esm/models/list-bid-results200-response.d.ts +1 -1
- package/dist/esm/models/list-bid-results200-response.js +1 -1
- package/dist/esm/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/esm/models/list-bids200-response-meta.js +1 -1
- package/dist/esm/models/list-bids200-response.d.ts +1 -1
- package/dist/esm/models/list-bids200-response.js +1 -1
- package/dist/esm/models/list-products200-response.d.ts +1 -1
- package/dist/esm/models/list-products200-response.js +1 -1
- package/dist/esm/models/list-webhook-deliveries-response-dto.d.ts +1 -1
- package/dist/esm/models/list-webhook-deliveries-response-dto.js +1 -1
- package/dist/esm/models/list-webhook-deliveries200-response.d.ts +1 -1
- package/dist/esm/models/list-webhook-deliveries200-response.js +1 -1
- package/dist/esm/models/list-webhook-endpoints200-response.d.ts +1 -1
- package/dist/esm/models/list-webhook-endpoints200-response.js +1 -1
- package/dist/esm/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/esm/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed201-response.js +1 -1
- package/dist/esm/models/negotiation-score-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-score-dto.js +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/esm/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/esm/models/oauth-error-response-dto.js +1 -1
- package/dist/esm/models/on-bid-award-reverted-request.d.ts +1 -1
- package/dist/esm/models/on-bid-award-reverted-request.js +1 -1
- package/dist/esm/models/on-bid-awarded-request.d.ts +1 -1
- package/dist/esm/models/on-bid-awarded-request.js +1 -1
- package/dist/esm/models/on-bid-canceled-request.d.ts +1 -1
- package/dist/esm/models/on-bid-canceled-request.js +1 -1
- package/dist/esm/models/on-bid-closed-request.d.ts +1 -1
- package/dist/esm/models/on-bid-closed-request.js +1 -1
- package/dist/esm/models/on-bid-failed-request.d.ts +1 -1
- package/dist/esm/models/on-bid-failed-request.js +1 -1
- package/dist/esm/models/on-ping-request.d.ts +1 -1
- package/dist/esm/models/on-ping-request.js +1 -1
- package/dist/esm/models/partner-webhook-delivery-status.d.ts +1 -1
- package/dist/esm/models/partner-webhook-delivery-status.js +1 -1
- package/dist/esm/models/partner-webhook-endpoint-status.d.ts +1 -1
- package/dist/esm/models/partner-webhook-endpoint-status.js +1 -1
- package/dist/esm/models/partner-webhook-event-type.d.ts +1 -1
- package/dist/esm/models/partner-webhook-event-type.js +1 -1
- package/dist/esm/models/payment-method-public.d.ts +1 -1
- package/dist/esm/models/payment-method-public.js +1 -1
- package/dist/esm/models/preconditions-dto.d.ts +1 -1
- package/dist/esm/models/preconditions-dto.js +1 -1
- package/dist/esm/models/problem-details-dto.d.ts +1 -1
- package/dist/esm/models/problem-details-dto.js +1 -1
- package/dist/esm/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/esm/models/product-receipt-response-dto.js +1 -1
- package/dist/esm/models/product-response-dto.d.ts +1 -1
- package/dist/esm/models/product-response-dto.js +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.js +1 -1
- package/dist/esm/models/register-award-request-dto.d.ts +1 -1
- package/dist/esm/models/register-award-request-dto.js +1 -1
- package/dist/esm/models/register-award201-response.d.ts +1 -1
- package/dist/esm/models/register-award201-response.js +1 -1
- package/dist/esm/models/register-bid201-response.d.ts +1 -1
- package/dist/esm/models/register-bid201-response.js +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/esm/models/request-invoice-split200-response.js +1 -1
- package/dist/esm/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-input-dto.js +1 -1
- package/dist/esm/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-row-dto.js +1 -1
- package/dist/esm/models/revert-award-request-dto.d.ts +1 -1
- package/dist/esm/models/revert-award-request-dto.js +1 -1
- package/dist/esm/models/revert-award200-response.d.ts +1 -1
- package/dist/esm/models/revert-award200-response.js +1 -1
- package/dist/esm/models/revoke-request-dto.d.ts +1 -1
- package/dist/esm/models/revoke-request-dto.js +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/esm/models/send-webhook-test-event200-response.d.ts +1 -1
- package/dist/esm/models/send-webhook-test-event200-response.js +1 -1
- package/dist/esm/models/statement-document-dto.d.ts +1 -1
- package/dist/esm/models/statement-document-dto.js +1 -1
- package/dist/esm/models/statement-product-dto.d.ts +1 -1
- package/dist/esm/models/statement-product-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/esm/models/supplier-tax-type.d.ts +1 -1
- package/dist/esm/models/supplier-tax-type.js +1 -1
- package/dist/esm/models/token-request-dto.d.ts +1 -1
- package/dist/esm/models/token-request-dto.js +1 -1
- package/dist/esm/models/token-response-dto.d.ts +1 -1
- package/dist/esm/models/token-response-dto.js +1 -1
- package/dist/esm/models/update-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/update-bid-request-dto.js +1 -1
- package/dist/esm/models/update-bid200-response.d.ts +1 -1
- package/dist/esm/models/update-bid200-response.js +1 -1
- package/dist/esm/models/update-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/esm/models/update-webhook-endpoint-request-dto.js +1 -1
- package/dist/esm/models/upload-file-request-dto.d.ts +1 -1
- package/dist/esm/models/upload-file-request-dto.js +1 -1
- package/dist/esm/models/upload-file201-response.d.ts +1 -1
- package/dist/esm/models/upload-file201-response.js +1 -1
- package/dist/esm/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/esm/models/upload-url-created-response-dto.js +1 -1
- package/dist/esm/models/webhook-bid-event-data.d.ts +1 -1
- package/dist/esm/models/webhook-bid-event-data.js +1 -1
- package/dist/esm/models/webhook-delivery-dto.d.ts +1 -1
- package/dist/esm/models/webhook-delivery-dto.js +1 -1
- package/dist/esm/models/webhook-endpoint-dto.d.ts +1 -1
- package/dist/esm/models/webhook-endpoint-dto.js +1 -1
- package/dist/esm/models/webhook-endpoint-with-secret-dto.d.ts +1 -1
- package/dist/esm/models/webhook-endpoint-with-secret-dto.js +1 -1
- package/dist/esm/models/webhook-event-envelope.d.ts +1 -1
- package/dist/esm/models/webhook-event-envelope.js +1 -1
- package/dist/esm/models/webhook-ping-event-data.d.ts +1 -1
- package/dist/esm/models/webhook-ping-event-data.js +1 -1
- package/dist/esm/models/webhook-test-result-dto.d.ts +1 -1
- package/dist/esm/models/webhook-test-result-dto.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/models/acceptance-result-response-dto.js +1 -1
- package/dist/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/models/acknowledge-products-request-dto.js +1 -1
- package/dist/models/api-catalog-dto.d.ts +1 -1
- package/dist/models/api-catalog-dto.js +1 -1
- package/dist/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/models/api-catalog-entry-dto.js +1 -1
- package/dist/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/models/api-catalog-link-dto.js +1 -1
- package/dist/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/models/authorization-server-metadata-dto.js +1 -1
- package/dist/models/award-method-public.d.ts +1 -1
- package/dist/models/award-method-public.js +1 -1
- package/dist/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/models/award-registered-v2-response-dto.js +1 -1
- package/dist/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/models/bid-acceptance-dto.js +1 -1
- package/dist/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/models/bid-attachment-input-dto.js +1 -1
- package/dist/models/bid-bond-dto.d.ts +1 -1
- package/dist/models/bid-bond-dto.js +1 -1
- package/dist/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/models/bid-cancelled-response-dto.js +1 -1
- package/dist/models/bid-contact-dto.d.ts +1 -1
- package/dist/models/bid-contact-dto.js +1 -1
- package/dist/models/bid-contacts-dto.d.ts +1 -1
- package/dist/models/bid-contacts-dto.js +1 -1
- package/dist/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/models/bid-contract-document-dto.js +1 -1
- package/dist/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/models/bid-delivery-terms-dto.js +1 -1
- package/dist/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/models/bid-detail-response-dto.js +1 -1
- package/dist/models/bid-document-dto.d.ts +1 -1
- package/dist/models/bid-document-dto.js +1 -1
- package/dist/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/models/bid-item-dto.d.ts +1 -1
- package/dist/models/bid-item-dto.js +1 -1
- package/dist/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/models/bid-lifecycle-dto.js +1 -1
- package/dist/models/bid-manager-dto.d.ts +1 -1
- package/dist/models/bid-manager-dto.js +1 -1
- package/dist/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/models/bid-payment-terms-dto.js +1 -1
- package/dist/models/bid-product-dto.d.ts +1 -1
- package/dist/models/bid-product-dto.js +1 -1
- package/dist/models/bid-public-status.d.ts +1 -1
- package/dist/models/bid-public-status.js +1 -1
- package/dist/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/models/bid-registered-response-dto.js +1 -1
- package/dist/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-dto.js +1 -1
- package/dist/models/bid-results-response-dto.d.ts +1 -1
- package/dist/models/bid-results-response-dto.js +1 -1
- package/dist/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/models/bid-settlement-participant-dto.js +1 -1
- package/dist/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/models/bid-settlement-response-dto.js +1 -1
- package/dist/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/models/bid-statement-response-dto.js +1 -1
- package/dist/models/bid-summary-dto.d.ts +1 -1
- package/dist/models/bid-summary-dto.js +1 -1
- package/dist/models/bid-type-public.d.ts +1 -1
- package/dist/models/bid-type-public.js +1 -1
- package/dist/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/models/bid-updated-response-dto.js +1 -1
- package/dist/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/models/cancel-bid-request-dto.js +1 -1
- package/dist/models/cancel-bid200-response.d.ts +1 -1
- package/dist/models/cancel-bid200-response.js +1 -1
- package/dist/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/models/card-payment-request-response-dto.js +1 -1
- package/dist/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/models/complete-acceptance-request-dto.js +1 -1
- package/dist/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/models/complete-acceptance200-response.js +1 -1
- package/dist/models/complete-invoice200-response.d.ts +1 -1
- package/dist/models/complete-invoice200-response.js +1 -1
- package/dist/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/models/complete-upload-request-dto.js +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/models/create-bid-request-dto.d.ts +1 -1
- package/dist/models/create-bid-request-dto.js +1 -1
- package/dist/models/create-card-payment-dto.d.ts +1 -1
- package/dist/models/create-card-payment-dto.js +1 -1
- package/dist/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/models/create-card-payment-request-dto.js +1 -1
- package/dist/models/create-card-payment200-response.d.ts +1 -1
- package/dist/models/create-card-payment200-response.js +1 -1
- package/dist/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/models/create-embed-launch201-response.js +1 -1
- package/dist/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/models/create-file-upload-url201-response.js +1 -1
- package/dist/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/models/create-upload-url-request-dto.js +1 -1
- package/dist/models/create-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/models/create-webhook-endpoint-request-dto.js +1 -1
- package/dist/models/create-webhook-endpoint201-response.d.ts +1 -1
- package/dist/models/create-webhook-endpoint201-response.js +1 -1
- package/dist/models/delivery-date-type-public.d.ts +1 -1
- package/dist/models/delivery-date-type-public.js +1 -1
- package/dist/models/delivery-method-public.d.ts +1 -1
- package/dist/models/delivery-method-public.js +1 -1
- package/dist/models/embed-bid-prefill-dto.d.ts +1 -5
- package/dist/models/embed-bid-prefill-dto.js +1 -1
- package/dist/models/embed-bid-prefill-item-dto.d.ts +1 -1
- package/dist/models/embed-bid-prefill-item-dto.js +1 -1
- package/dist/models/embed-bid-prefill-manager-dto.d.ts +1 -1
- package/dist/models/embed-bid-prefill-manager-dto.js +1 -1
- package/dist/models/embed-launch-request-dto.d.ts +5 -5
- package/dist/models/embed-launch-request-dto.js +1 -1
- package/dist/models/embed-launch-response-dto.d.ts +1 -1
- package/dist/models/embed-launch-response-dto.js +1 -1
- package/dist/models/excellent-procurement-public.d.ts +1 -1
- package/dist/models/excellent-procurement-public.js +1 -1
- package/dist/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/models/external-contract-document-item-dto.js +1 -1
- package/dist/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/external-contract-documents-response-dto.js +1 -1
- package/dist/models/external-contract-item-dto.d.ts +1 -1
- package/dist/models/external-contract-item-dto.js +1 -1
- package/dist/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/models/external-contract-snapshot-dto.js +1 -1
- package/dist/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/models/external-document-inputs-dto.js +1 -1
- package/dist/models/file-meta-response-dto.d.ts +1 -1
- package/dist/models/file-meta-response-dto.js +1 -1
- package/dist/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/models/file-uploaded-response-dto.js +1 -1
- package/dist/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/models/generated-external-contract-document-dto.js +1 -1
- package/dist/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/models/get-bid-settlement200-response.js +1 -1
- package/dist/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/models/get-bid-statement200-response.js +1 -1
- package/dist/models/get-bid200-response.d.ts +1 -1
- package/dist/models/get-bid200-response.js +1 -1
- package/dist/models/get-file-meta200-response.d.ts +1 -1
- package/dist/models/get-file-meta200-response.js +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/models/get-webhook-endpoint200-response.d.ts +1 -1
- package/dist/models/get-webhook-endpoint200-response.js +1 -1
- package/dist/models/green-product-public.d.ts +1 -1
- package/dist/models/green-product-public.js +1 -1
- package/dist/models/health-controller-check200-response.d.ts +1 -1
- package/dist/models/health-controller-check200-response.js +1 -1
- package/dist/models/health-response-dto.d.ts +1 -1
- package/dist/models/health-response-dto.js +1 -1
- package/dist/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/models/hierarchical-region-dto.js +1 -1
- package/dist/models/introspect-request-dto.d.ts +1 -1
- package/dist/models/introspect-request-dto.js +1 -1
- package/dist/models/introspection-response-dto.d.ts +1 -1
- package/dist/models/introspection-response-dto.js +1 -1
- package/dist/models/invalid-param-dto.d.ts +1 -1
- package/dist/models/invalid-param-dto.js +1 -1
- package/dist/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/models/invoice-completed-response-dto.js +1 -1
- package/dist/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/models/invoice-split-response-dto.js +1 -1
- package/dist/models/legal-mandatory-public.d.ts +1 -1
- package/dist/models/legal-mandatory-public.js +1 -1
- package/dist/models/list-bid-results200-response.d.ts +1 -1
- package/dist/models/list-bid-results200-response.js +1 -1
- package/dist/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/models/list-bids200-response-meta.js +1 -1
- package/dist/models/list-bids200-response.d.ts +1 -1
- package/dist/models/list-bids200-response.js +1 -1
- package/dist/models/list-products200-response.d.ts +1 -1
- package/dist/models/list-products200-response.js +1 -1
- package/dist/models/list-webhook-deliveries-response-dto.d.ts +1 -1
- package/dist/models/list-webhook-deliveries-response-dto.js +1 -1
- package/dist/models/list-webhook-deliveries200-response.d.ts +1 -1
- package/dist/models/list-webhook-deliveries200-response.js +1 -1
- package/dist/models/list-webhook-endpoints200-response.d.ts +1 -1
- package/dist/models/list-webhook-endpoints200-response.js +1 -1
- package/dist/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/models/mark-bid-failed201-response.js +1 -1
- package/dist/models/negotiation-score-dto.d.ts +1 -1
- package/dist/models/negotiation-score-dto.js +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/models/oauth-error-response-dto.js +1 -1
- package/dist/models/on-bid-award-reverted-request.d.ts +1 -1
- package/dist/models/on-bid-award-reverted-request.js +1 -1
- package/dist/models/on-bid-awarded-request.d.ts +1 -1
- package/dist/models/on-bid-awarded-request.js +1 -1
- package/dist/models/on-bid-canceled-request.d.ts +1 -1
- package/dist/models/on-bid-canceled-request.js +1 -1
- package/dist/models/on-bid-closed-request.d.ts +1 -1
- package/dist/models/on-bid-closed-request.js +1 -1
- package/dist/models/on-bid-failed-request.d.ts +1 -1
- package/dist/models/on-bid-failed-request.js +1 -1
- package/dist/models/on-ping-request.d.ts +1 -1
- package/dist/models/on-ping-request.js +1 -1
- package/dist/models/partner-webhook-delivery-status.d.ts +1 -1
- package/dist/models/partner-webhook-delivery-status.js +1 -1
- package/dist/models/partner-webhook-endpoint-status.d.ts +1 -1
- package/dist/models/partner-webhook-endpoint-status.js +1 -1
- package/dist/models/partner-webhook-event-type.d.ts +1 -1
- package/dist/models/partner-webhook-event-type.js +1 -1
- package/dist/models/payment-method-public.d.ts +1 -1
- package/dist/models/payment-method-public.js +1 -1
- package/dist/models/preconditions-dto.d.ts +1 -1
- package/dist/models/preconditions-dto.js +1 -1
- package/dist/models/problem-details-dto.d.ts +1 -1
- package/dist/models/problem-details-dto.js +1 -1
- package/dist/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/models/product-receipt-response-dto.js +1 -1
- package/dist/models/product-response-dto.d.ts +1 -1
- package/dist/models/product-response-dto.js +1 -1
- package/dist/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/models/protected-resource-metadata-dto.js +1 -1
- package/dist/models/register-award-request-dto.d.ts +1 -1
- package/dist/models/register-award-request-dto.js +1 -1
- package/dist/models/register-award201-response.d.ts +1 -1
- package/dist/models/register-award201-response.js +1 -1
- package/dist/models/register-bid201-response.d.ts +1 -1
- package/dist/models/register-bid201-response.js +1 -1
- package/dist/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/models/register-semo-contract-request-dto.js +1 -1
- package/dist/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/models/request-invoice-split-request-dto.js +1 -1
- package/dist/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/models/request-invoice-split200-response.js +1 -1
- package/dist/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/models/retiree-roster-input-dto.js +1 -1
- package/dist/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/models/retiree-roster-row-dto.js +1 -1
- package/dist/models/revert-award-request-dto.d.ts +1 -1
- package/dist/models/revert-award-request-dto.js +1 -1
- package/dist/models/revert-award200-response.d.ts +1 -1
- package/dist/models/revert-award200-response.js +1 -1
- package/dist/models/revoke-request-dto.d.ts +1 -1
- package/dist/models/revoke-request-dto.js +1 -1
- package/dist/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/models/send-webhook-test-event200-response.d.ts +1 -1
- package/dist/models/send-webhook-test-event200-response.js +1 -1
- package/dist/models/statement-document-dto.d.ts +1 -1
- package/dist/models/statement-document-dto.js +1 -1
- package/dist/models/statement-product-dto.d.ts +1 -1
- package/dist/models/statement-product-dto.js +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/models/supplier-tax-type.d.ts +1 -1
- package/dist/models/supplier-tax-type.js +1 -1
- package/dist/models/token-request-dto.d.ts +1 -1
- package/dist/models/token-request-dto.js +1 -1
- package/dist/models/token-response-dto.d.ts +1 -1
- package/dist/models/token-response-dto.js +1 -1
- package/dist/models/update-bid-request-dto.d.ts +1 -1
- package/dist/models/update-bid-request-dto.js +1 -1
- package/dist/models/update-bid200-response.d.ts +1 -1
- package/dist/models/update-bid200-response.js +1 -1
- package/dist/models/update-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/models/update-webhook-endpoint-request-dto.js +1 -1
- package/dist/models/upload-file-request-dto.d.ts +1 -1
- package/dist/models/upload-file-request-dto.js +1 -1
- package/dist/models/upload-file201-response.d.ts +1 -1
- package/dist/models/upload-file201-response.js +1 -1
- package/dist/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/models/upload-url-created-response-dto.js +1 -1
- package/dist/models/webhook-bid-event-data.d.ts +1 -1
- package/dist/models/webhook-bid-event-data.js +1 -1
- package/dist/models/webhook-delivery-dto.d.ts +1 -1
- package/dist/models/webhook-delivery-dto.js +1 -1
- package/dist/models/webhook-endpoint-dto.d.ts +1 -1
- package/dist/models/webhook-endpoint-dto.js +1 -1
- package/dist/models/webhook-endpoint-with-secret-dto.d.ts +1 -1
- package/dist/models/webhook-endpoint-with-secret-dto.js +1 -1
- package/dist/models/webhook-event-envelope.d.ts +1 -1
- package/dist/models/webhook-event-envelope.js +1 -1
- package/dist/models/webhook-ping-event-data.d.ts +1 -1
- package/dist/models/webhook-ping-event-data.js +1 -1
- package/dist/models/webhook-test-result-dto.d.ts +1 -1
- package/dist/models/webhook-test-result-dto.js +1 -1
- package/docs/EmbedApi.md +1 -1
- package/docs/EmbedBidPrefillDto.md +0 -2
- package/docs/EmbedLaunchRequestDto.md +4 -4
- package/index.ts +1 -1
- package/models/acceptance-result-response-dto.ts +1 -1
- package/models/acknowledge-product-receipt200-response.ts +1 -1
- package/models/acknowledge-products-request-dto.ts +1 -1
- package/models/api-catalog-dto.ts +1 -1
- package/models/api-catalog-entry-dto.ts +1 -1
- package/models/api-catalog-link-dto.ts +1 -1
- package/models/authorization-server-metadata-dto.ts +1 -1
- package/models/award-method-public.ts +1 -1
- package/models/award-registered-v2-response-dto.ts +1 -1
- package/models/award-reverted-v2-response-dto.ts +1 -1
- package/models/bid-acceptance-dto.ts +1 -1
- package/models/bid-attachment-input-dto.ts +1 -1
- package/models/bid-bond-dto.ts +1 -1
- package/models/bid-cancelled-response-dto.ts +1 -1
- package/models/bid-contact-dto.ts +1 -1
- package/models/bid-contacts-dto.ts +1 -1
- package/models/bid-contract-document-dto.ts +1 -1
- package/models/bid-delivery-terms-dto.ts +1 -1
- package/models/bid-detail-response-dto.ts +1 -1
- package/models/bid-document-dto.ts +1 -1
- package/models/bid-failed-v2-response-dto.ts +1 -1
- package/models/bid-item-dto.ts +1 -1
- package/models/bid-lifecycle-dto.ts +1 -1
- package/models/bid-manager-dto.ts +1 -1
- package/models/bid-payment-terms-dto.ts +1 -1
- package/models/bid-product-dto.ts +1 -1
- package/models/bid-public-status.ts +1 -1
- package/models/bid-registered-response-dto.ts +1 -1
- package/models/bid-result-participant-attachment-dto.ts +1 -1
- package/models/bid-result-participant-dto.ts +1 -1
- package/models/bid-results-response-dto.ts +1 -1
- package/models/bid-settlement-line-item-dto.ts +1 -1
- package/models/bid-settlement-participant-dto.ts +1 -1
- package/models/bid-settlement-response-dto.ts +1 -1
- package/models/bid-statement-response-dto.ts +1 -1
- package/models/bid-summary-dto.ts +1 -1
- package/models/bid-type-public.ts +1 -1
- package/models/bid-updated-response-dto.ts +1 -1
- package/models/cancel-bid-request-dto.ts +1 -1
- package/models/cancel-bid200-response.ts +1 -1
- package/models/card-payment-request-response-dto.ts +1 -1
- package/models/complete-acceptance-request-dto.ts +1 -1
- package/models/complete-acceptance200-response.ts +1 -1
- package/models/complete-invoice200-response.ts +1 -1
- package/models/complete-upload-request-dto.ts +1 -1
- package/models/contract-restriction-confirm-input-dto.ts +1 -1
- package/models/create-bid-request-dto.ts +1 -1
- package/models/create-card-payment-dto.ts +1 -1
- package/models/create-card-payment-request-dto.ts +1 -1
- package/models/create-card-payment200-response.ts +1 -1
- package/models/create-embed-launch201-response.ts +1 -1
- package/models/create-external-contract-documents-request-dto.ts +1 -1
- package/models/create-external-contract-documents-response-dto.ts +1 -1
- package/models/create-file-upload-url201-response.ts +1 -1
- package/models/create-upload-url-request-dto.ts +1 -1
- package/models/create-webhook-endpoint-request-dto.ts +1 -1
- package/models/create-webhook-endpoint201-response.ts +1 -1
- package/models/delivery-date-type-public.ts +1 -1
- package/models/delivery-method-public.ts +1 -1
- package/models/embed-bid-prefill-dto.ts +1 -5
- package/models/embed-bid-prefill-item-dto.ts +1 -1
- package/models/embed-bid-prefill-manager-dto.ts +1 -1
- package/models/embed-launch-request-dto.ts +5 -5
- package/models/embed-launch-response-dto.ts +1 -1
- package/models/excellent-procurement-public.ts +1 -1
- package/models/external-contract-document-item-dto.ts +1 -1
- package/models/external-contract-documents-response-dto.ts +1 -1
- package/models/external-contract-item-dto.ts +1 -1
- package/models/external-contract-snapshot-dto.ts +1 -1
- package/models/external-document-inputs-dto.ts +1 -1
- package/models/file-meta-response-dto.ts +1 -1
- package/models/file-uploaded-response-dto.ts +1 -1
- package/models/generated-external-contract-document-dto.ts +1 -1
- package/models/get-bid-settlement200-response.ts +1 -1
- package/models/get-bid-statement200-response.ts +1 -1
- package/models/get-bid200-response.ts +1 -1
- package/models/get-file-meta200-response.ts +1 -1
- package/models/get-supplier-card-payable-v2200-response.ts +1 -1
- package/models/get-webhook-endpoint200-response.ts +1 -1
- package/models/green-product-public.ts +1 -1
- package/models/health-controller-check200-response.ts +1 -1
- package/models/health-response-dto.ts +1 -1
- package/models/hierarchical-region-dto.ts +1 -1
- package/models/introspect-request-dto.ts +1 -1
- package/models/introspection-response-dto.ts +1 -1
- package/models/invalid-param-dto.ts +1 -1
- package/models/invoice-completed-response-dto.ts +1 -1
- package/models/invoice-split-response-dto.ts +1 -1
- package/models/legal-mandatory-public.ts +1 -1
- package/models/list-bid-results200-response.ts +1 -1
- package/models/list-bids200-response-meta.ts +1 -1
- package/models/list-bids200-response.ts +1 -1
- package/models/list-products200-response.ts +1 -1
- package/models/list-webhook-deliveries-response-dto.ts +1 -1
- package/models/list-webhook-deliveries200-response.ts +1 -1
- package/models/list-webhook-endpoints200-response.ts +1 -1
- package/models/mark-bid-failed-request-dto.ts +1 -1
- package/models/mark-bid-failed201-response.ts +1 -1
- package/models/negotiation-score-dto.ts +1 -1
- package/models/negotiation-scored-v2-response-dto.ts +1 -1
- package/models/oauth-error-response-dto.ts +1 -1
- package/models/on-bid-award-reverted-request.ts +1 -1
- package/models/on-bid-awarded-request.ts +1 -1
- package/models/on-bid-canceled-request.ts +1 -1
- package/models/on-bid-closed-request.ts +1 -1
- package/models/on-bid-failed-request.ts +1 -1
- package/models/on-ping-request.ts +1 -1
- package/models/partner-webhook-delivery-status.ts +1 -1
- package/models/partner-webhook-endpoint-status.ts +1 -1
- package/models/partner-webhook-event-type.ts +1 -1
- package/models/payment-method-public.ts +1 -1
- package/models/preconditions-dto.ts +1 -1
- package/models/problem-details-dto.ts +1 -1
- package/models/product-receipt-response-dto.ts +1 -1
- package/models/product-response-dto.ts +1 -1
- package/models/protected-resource-metadata-dto.ts +1 -1
- package/models/register-award-request-dto.ts +1 -1
- package/models/register-award201-response.ts +1 -1
- package/models/register-bid201-response.ts +1 -1
- package/models/register-semo-contract-request-dto.ts +1 -1
- package/models/request-invoice-split-request-dto.ts +1 -1
- package/models/request-invoice-split200-response.ts +1 -1
- package/models/retiree-roster-input-dto.ts +1 -1
- package/models/retiree-roster-row-dto.ts +1 -1
- package/models/revert-award-request-dto.ts +1 -1
- package/models/revert-award200-response.ts +1 -1
- package/models/revoke-request-dto.ts +1 -1
- package/models/semo-contract-registered-response-dto.ts +1 -1
- package/models/semo-contract-taxinvoice-status-response-dto.ts +1 -1
- package/models/send-webhook-test-event200-response.ts +1 -1
- package/models/statement-document-dto.ts +1 -1
- package/models/statement-product-dto.ts +1 -1
- package/models/submit-negotiation-scores-request-dto.ts +1 -1
- package/models/submit-negotiation-scores201-response.ts +1 -1
- package/models/supplier-card-payable-response-dto.ts +1 -1
- package/models/supplier-tax-type.ts +1 -1
- package/models/token-request-dto.ts +1 -1
- package/models/token-response-dto.ts +1 -1
- package/models/update-bid-request-dto.ts +1 -1
- package/models/update-bid200-response.ts +1 -1
- package/models/update-webhook-endpoint-request-dto.ts +1 -1
- package/models/upload-file-request-dto.ts +1 -1
- package/models/upload-file201-response.ts +1 -1
- package/models/upload-url-created-response-dto.ts +1 -1
- package/models/webhook-bid-event-data.ts +1 -1
- package/models/webhook-delivery-dto.ts +1 -1
- package/models/webhook-endpoint-dto.ts +1 -1
- package/models/webhook-endpoint-with-secret-dto.ts +1 -1
- package/models/webhook-event-envelope.ts +1 -1
- package/models/webhook-ping-event-data.ts +1 -1
- package/models/webhook-test-result-dto.ts +1 -1
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -16,15 +16,15 @@ export interface EmbedLaunchRequestDto {
|
|
|
16
16
|
*/
|
|
17
17
|
'memberId': string;
|
|
18
18
|
/**
|
|
19
|
-
* μλ² λλ₯Ό μ΄μμ λ **μ²μ 보μΌ
|
|
19
|
+
* μλ² λλ₯Ό μ΄μμ λ **μ²μ λ³΄μΌ νλ©΄**μ
λλ€ β `bid-register`=κ³΅κ³ λ±λ‘ Β· `bid-list`=κ³΅κ³ λͺ©λ‘ Β· `bid-detail`=κ³΅κ³ μμΈ Β· `assistant`=AI 리ν¬νΈ μ΄μμ€νΈ Β· `payment`=λκΈκ²°μ Β· `savings`=μμ°μ κ° μ€μ . νμ©λμ§ μμ κ°μ΄λ©΄ 400μ
λλ€. μ΄ μΈμ
μΌλ‘ μΈ μ μλ νλ©΄ μ 체λ componentsλ‘ μ ν©λλ€. `bid-detail` Β· `payment` λ λμ κ³΅κ³ κ° μμ΄μΌ μ΄λ¦¬λ―λ‘ targetBidIdλ₯Ό ν¨κ» 보λ΄μΈμ(μμΌλ©΄ 400).
|
|
20
20
|
*/
|
|
21
21
|
'screen': EmbedLaunchRequestDtoScreenEnum;
|
|
22
22
|
/**
|
|
23
|
-
* μ΄ μΈμ
μΌλ‘ μΈ μ μλ νλ©΄(=μ»΄ν¬λνΈ) μ§ν©μ
λλ€. μ¬λ¬ κ°λ₯Ό μ£Όλ©΄ μλ² λκ° μλ¨ νμΌλ‘ κ·Έλ¦¬κ³ , μ¬μ©μκ° μ launch URL μμ΄ κ·Έ μ¬μ΄λ₯Ό μ€κ°λλ€. screenμ μλμΌλ‘ ν¬ν¨λ©λλ€. **νμ λͺ©λ‘μ΄ μλλΌ κΆνμ
λλ€** β μ¬κΈ°μ μλ νλ©΄μ κΈ°λ₯μ μλ²κ° 403μΌλ‘ κ±°μ ν©λλ€. λ΄λΉμ μν μ΄ μ¬λΏμ΄λ©΄(λ±λ‘λ§ κ°λ₯ν μ€λ¬΄μ / κ²°μ κΉμ§ κ°λ₯ν κ²°μ¬μ) μν μ λ§μΆ° μ’νμ λ°κΈνμΈμ. μλ΅νλ©΄ screen νλλ§ μ΄λ¦° μΈμ
μ΄ λ©λλ€.
|
|
23
|
+
* μ΄ μΈμ
μΌλ‘ μΈ μ μλ νλ©΄(=μ»΄ν¬λνΈ) μ§ν©μ
λλ€. μ¬λ¬ κ°λ₯Ό μ£Όλ©΄ μλ² λκ° μλ¨ νμΌλ‘ κ·Έλ¦¬κ³ , μ¬μ©μκ° μ launch URL μμ΄ κ·Έ μ¬μ΄λ₯Ό μ€κ°λλ€. screenμ μλμΌλ‘ ν¬ν¨λ©λλ€. **νμ λͺ©λ‘μ΄ μλλΌ κΆνμ
λλ€** β μ¬κΈ°μ μλ νλ©΄μ κΈ°λ₯μ μλ²κ° 403μΌλ‘ κ±°μ ν©λλ€. λ΄λΉμ μν μ΄ μ¬λΏμ΄λ©΄(λ±λ‘λ§ κ°λ₯ν μ€λ¬΄μ / κ²°μ κΉμ§ κ°λ₯ν κ²°μ¬μ) μν μ λ§μΆ° μ’νμ λ°κΈνμΈμ. μλ΅νλ©΄ screen νλλ§ μ΄λ¦° μΈμ
μ΄ λ©λλ€. **μ건μ μ΄λ¦° νλ©΄λ€μ ν©μ§ν©μ
λλ€** β `bid-detail` Β· `payment` κ° νλλΌλ μμ΄λ©΄ κ·Έ μΈμ
μ targetBidIdκ° νμν©λλ€.
|
|
24
24
|
*/
|
|
25
25
|
'components'?: Array<EmbedLaunchRequestDtoComponentsEnum>;
|
|
26
26
|
/**
|
|
27
|
-
* μλ² λ μΈμ
μ νΉμ κ³΅κ³ λ‘ μ€μ½νν λμ κ³΅κ³ μλ³μ(ꡬ맀λ²νΈ λλ λ±λ‘ μλ΅μ κ³΅κ³ λ²νΈ). μ§μ νλ©΄ μ΄ ννΈλ ν€κ° μμ ν κ³΅κ³ μ¬μΌ νκ³ (λ€λ₯Έ λ°μ£ΌκΈ°κ΄μ κ³΅κ³ λ 403), μΈμ
μ κ·Έ κ³΅κ³ μλ§ μ μ©λ©λλ€. μλ΅νλ©΄ νλ©΄ μ μ(member-scoped)
|
|
27
|
+
* μλ² λ μΈμ
μ νΉμ κ³΅κ³ λ‘ μ€μ½νν λμ κ³΅κ³ μλ³μ(ꡬ맀λ²νΈ λλ λ±λ‘ μλ΅μ κ³΅κ³ λ²νΈ). μ§μ νλ©΄ μ΄ ννΈλ ν€κ° μμ ν κ³΅κ³ μ¬μΌ νκ³ (λ€λ₯Έ λ°μ£ΌκΈ°κ΄μ κ³΅κ³ λ 403), μΈμ
μ κ·Έ κ³΅κ³ μλ§ μ μ©λ©λλ€. `bid-detail` Β· `payment` νλ©΄μλ **νμ**μ
λλ€ β κ·Έ νλ©΄λ€μ λμ κ³΅κ³ κ° μμΌλ©΄ 그릴 κ²μ΄ μμ΄ λ°κΈμ΄ 400μ
λλ€. λλ¨Έμ§ νλ©΄λ§ μ¬λ μΈμ
μμλ μλ΅νλ©΄ νλ©΄ μ μ(member-scoped) μΈμ
μ΄ λ©λλ€. μλ²κ° ꡬ맀λ²νΈλ₯Ό λ΄λΆ κ³΅κ³ λ²νΈλ‘ ν΄μν΄ μΈμ
μ λ°μΌλ―λ‘, νλ©΄μ μ΄ κ°μΌλ‘λ§ μ‘°νν©λλ€ β λμ κ³΅κ³ λ₯Ό prefillλ‘ λ°λ‘ λκΈΈ νμκ° μμ΅λλ€.
|
|
28
28
|
*/
|
|
29
29
|
'targetBidId'?: string;
|
|
30
30
|
/**
|
|
@@ -32,7 +32,7 @@ export interface EmbedLaunchRequestDto {
|
|
|
32
32
|
*/
|
|
33
33
|
'parentOrigin'?: string;
|
|
34
34
|
/**
|
|
35
|
-
* νλ©΄μ 미리 μ±μ μ΄κΈ° μν κ°μ
λλ€.
|
|
35
|
+
* νλ©΄μ 미리 μ±μ μ΄κΈ° μν κ°μ
λλ€. μ΄ κ°μ μ½λ νλ©΄μ `bid-register` μ΄κ³ (`paymentMethod` λ§ `payment` νλ©΄λ ν¨κ» μ½μ΅λλ€), λλ¨Έμ§ νλ©΄μ 무μν λΏ μ€λ₯κ° μλλλ€ β ν μΈμ
μ΄ componentsλ‘ νμ μ¬λ¬ κ° μ΄λ©΄ κ·Έ νλ©΄λ€μ΄ μ΄ ν κ°μ²΄λ₯Ό ν¨κ» λ΄
λλ€. `purchaseNo`λ κ³΅κ³ λ±λ‘(`POST /v2/bids`)κ³Ό κ°μ μΆμ
λλ€ β μ«μλ‘ μμνλ©΄ κ³΅κ³ λ²νΈλ‘ μ€μΈλλ μνλ²³ μ λμ¬λ₯Ό λΆμ΄μΈμ. **λμ κ³΅κ³ λ μ¬κΈ°κ° μλλΌ `targetBidId`λ‘ μ§μ ν©λλ€.** **κ°μ λΉκΆμμ
λλ€** β νΌ κΈ°λ³Έκ°μΌ λΏμ΄κ³ μ΅μ’
κ²μ¦μ μ μΆ μμ μ μλ²κ° ν©λλ€. λμ°°λ°©λ²μ²λΌ μνλ¨Έμ μ μ½ν κ°μ λ°μ§ μμ΅λλ€. λ€λ§ **λͺ¨μμ μ¬κΈ°μ κ²μ¦ν©λλ€** β λ―ΈμΈμ νλλ νμ
λΆμΌμΉλ 400μ
λλ€(μ νλ©΄ κ³΅ν΅ κ·μ½). ν΅κ³ΌμμΌ λκ³ νλ©΄μ΄ μ‘°μ©ν λ²λ¦¬λ©΄ μ°λμ¬λ λΉ νΌλ§ λ³΄κ³ μμΈμ μ°Ύμ§ λͺ»ν©λλ€.
|
|
36
36
|
*/
|
|
37
37
|
'prefill'?: EmbedBidPrefillDto;
|
|
38
38
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 42.0.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token`μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403`μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£ΌκΈ°κ΄ λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2`μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }`μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data`κ° λ°°μ΄μ΄κ³ `meta`κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta`κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*`μ `/.well-known/_*`λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSONμ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+jsonμ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2`μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified`λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json`μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId`μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId`λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type`μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1μ΄ νμ©νλ λλ‘ μ΄ URIλ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409μ 422μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id`κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slugμ **HTTP statusλ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 42.0.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|