@cmarket/partner-sdk 42.0.2 β 43.0.1
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 -9
- package/api/embed-api.ts +5 -5
- package/api/oauth-api.ts +1 -1
- package/api/partner-api-api.ts +5 -98
- 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 +5 -47
- package/dist/api/partner-api-api.js +5 -91
- 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 +5 -47
- package/dist/esm/api/partner-api-api.js +5 -91
- 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 -1
- 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 +1 -1
- 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/index.d.ts +0 -4
- package/dist/esm/models/index.js +0 -4
- 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/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/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 -1
- 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 +1 -1
- 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/index.d.ts +0 -4
- package/dist/models/index.js +0 -4
- 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/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/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/PartnerApiApi.md +1 -69
- 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 -1
- 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 +1 -1
- 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/index.ts +0 -4
- 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/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/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
- package/dist/esm/models/negotiation-score-dto.d.ts +0 -25
- package/dist/esm/models/negotiation-score-dto.js +0 -14
- package/dist/esm/models/negotiation-scored-v2-response-dto.d.ts +0 -29
- package/dist/esm/models/negotiation-scored-v2-response-dto.js +0 -16
- package/dist/esm/models/submit-negotiation-scores-request-dto.d.ts +0 -22
- package/dist/esm/models/submit-negotiation-scores-request-dto.js +0 -14
- package/dist/esm/models/submit-negotiation-scores201-response.d.ts +0 -15
- package/dist/esm/models/submit-negotiation-scores201-response.js +0 -14
- package/dist/models/negotiation-score-dto.d.ts +0 -25
- package/dist/models/negotiation-score-dto.js +0 -15
- package/dist/models/negotiation-scored-v2-response-dto.d.ts +0 -29
- package/dist/models/negotiation-scored-v2-response-dto.js +0 -19
- package/dist/models/submit-negotiation-scores-request-dto.d.ts +0 -22
- package/dist/models/submit-negotiation-scores-request-dto.js +0 -15
- package/dist/models/submit-negotiation-scores201-response.d.ts +0 -15
- package/dist/models/submit-negotiation-scores201-response.js +0 -15
- package/docs/NegotiationScoreDto.md +0 -24
- package/docs/NegotiationScoredV2ResponseDto.md +0 -24
- package/docs/SubmitNegotiationScores201Response.md +0 -20
- package/docs/SubmitNegotiationScoresRequestDto.md +0 -22
- package/models/negotiation-score-dto.ts +0 -31
- package/models/negotiation-scored-v2-response-dto.ts +0 -38
- package/models/submit-negotiation-scores-request-dto.ts +0 -30
- package/models/submit-negotiation-scores201-response.ts +0 -23
package/docs/PartnerApiApi.md
CHANGED
|
@@ -35,7 +35,6 @@ All URIs are relative to *https://partner-api.c-market.net*
|
|
|
35
35
|
|[**revertAward**](#revertaward) | **DELETE** /v2/bids/{bidRef}/award | λμ°° λλ리기|
|
|
36
36
|
|[**rotateWebhookSecret**](#rotatewebhooksecret) | **POST** /v2/webhook-endpoints/{endpointId}/rotate-secret | μΉν
μλͺ
μν¬λ¦Ώ μ¬λ°κΈ|
|
|
37
37
|
|[**sendWebhookTestEvent**](#sendwebhooktestevent) | **POST** /v2/webhook-endpoints/{endpointId}/test | μΉν
μ°κ²° νμΈ λ°μ‘|
|
|
38
|
-
|[**submitNegotiationScores**](#submitnegotiationscores) | **POST** /v2/bids/{bidRef}/negotiation-scores | νμ μ μνκ°|
|
|
39
38
|
|[**updateBid**](#updatebid) | **PATCH** /v2/bids/{bidRef} | κ³΅κ³ μμ |
|
|
40
39
|
|[**updateWebhookEndpoint**](#updatewebhookendpoint) | **PATCH** /v2/webhook-endpoints/{endpointId} | μΉν
ꡬλ
μμ |
|
|
41
40
|
|[**uploadFile**](#uploadfile) | **POST** /v2/files | κ³΅κ³ μ²¨λΆνμΌ μ
λ‘λ (κΈ°λ³Έ)|
|
|
@@ -1567,7 +1566,7 @@ const { status, data } = await apiInstance.markBidFailed(
|
|
|
1567
1566
|
# **registerAward**
|
|
1568
1567
|
> RegisterAward201Response registerAward(registerAwardRequestDto)
|
|
1569
1568
|
|
|
1570
|
-
λμ°° κ²°κ³Όλ₯Ό λ±λ‘ν©λλ€. μ€μ½ν `awards:write` Β· `Idempotency-Key` ν€λ νμ. - μ
μ°° λ§κ°(μ
μ°°μλ£) μνμμ νΈμΆν©λλ€. - λμ°° ν κ³΅κ³ μνλ κ³μ½μ§ν(`CONTRACT_IN_PROGRESS`)μ
λλ€. `AWARDED` κ³΅κ³ μνλ μμΌλ―λ‘ λμ°° μ¬λΆλ `participants[].isWinner`λ‘ νλ¨ν©λλ€. - νμ λ°©μ(`NEGOTIATION`, `NEGOTIATION_AUTO`) κ³΅κ³ λ
|
|
1569
|
+
λμ°° κ²°κ³Όλ₯Ό λ±λ‘ν©λλ€. μ€μ½ν `awards:write` Β· `Idempotency-Key` ν€λ νμ. - μ
μ°° λ§κ°(μ
μ°°μλ£) μνμμ νΈμΆν©λλ€. - λμ°° ν κ³΅κ³ μνλ κ³μ½μ§ν(`CONTRACT_IN_PROGRESS`)μ
λλ€. `AWARDED` κ³΅κ³ μνλ μμΌλ―λ‘ λμ°° μ¬λΆλ `participants[].isWinner`λ‘ νλ¨ν©λλ€. - νμ λ°©μ(`NEGOTIATION`, `NEGOTIATION_AUTO`) κ³΅κ³ λ νκ°λ₯Ό λ§μ³μΌ νΈμΆν μ μμ΅λλ€. μ μνκ°λ APIλ‘ μ 곡νμ§ μμΌλ©° CMARKET νλ©΄(μλ² λ ν¬ν¨)μμ μ§νν©λλ€. - λ°μ£ΌκΈ°κ΄μ API ν€λ‘ κ²°μ λ©λλ€(`buyerId`λ₯Ό 보λ΄μ§ μμ΅λλ€). - κ°μ ν€μ κ°μ bodyλ‘ μ¬μ μ‘νλ©΄ 24μκ° λμ μΊμλ μλ΅μ λλ €μ€λλ€.
|
|
1571
1570
|
|
|
1572
1571
|
### Example
|
|
1573
1572
|
|
|
@@ -2019,73 +2018,6 @@ const { status, data } = await apiInstance.sendWebhookTestEvent(
|
|
|
2019
2018
|
|
|
2020
2019
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2021
2020
|
|
|
2022
|
-
# **submitNegotiationScores**
|
|
2023
|
-
> SubmitNegotiationScores201Response submitNegotiationScores(submitNegotiationScoresRequestDto)
|
|
2024
|
-
|
|
2025
|
-
νμ λ°©μ(`NEGOTIATION`, `NEGOTIATION_AUTO`) κ³΅κ³ μ μμ°°μλ³ μ μλ₯Ό μ
λ ₯ν©λλ€. μ€μ½ν `awards:write` Β· `Idempotency-Key` ν€λ νμ. - μ
μ°° λ§κ° ν λμ°°(`POST /v2/bids/{bidRef}/award`) μ μ νΈμΆν©λλ€. νμ λ°©μ κ³΅κ³ λ μ΄ νκ°λ₯Ό λ§μ³μΌ λμ°°μ μ§μ
ν©λλ€. - `complete=true`λ©΄ νκ°μλ£λ‘ μ²λ¦¬λμ΄ λμ°°μ νΈμΆν μ μμ΅λλ€. - λ°μ£ΌκΈ°κ΄μ API ν€λ‘ κ²°μ λ©λλ€(`buyerId`λ₯Ό 보λ΄μ§ μμ΅λλ€).
|
|
2026
|
-
|
|
2027
|
-
### Example
|
|
2028
|
-
|
|
2029
|
-
```typescript
|
|
2030
|
-
import {
|
|
2031
|
-
PartnerApiApi,
|
|
2032
|
-
Configuration,
|
|
2033
|
-
SubmitNegotiationScoresRequestDto
|
|
2034
|
-
} from '@cmarket/partner-sdk';
|
|
2035
|
-
|
|
2036
|
-
const configuration = new Configuration();
|
|
2037
|
-
const apiInstance = new PartnerApiApi(configuration);
|
|
2038
|
-
|
|
2039
|
-
let bidRef: string; //λ°μ£ΌκΈ°κ΄ μ체 ꡬ맀λ²νΈ(κΆμ₯) λλ c-market κ³΅κ³ λ²νΈ. ꡬ맀λ²νΈλ ν€μ μ°κ²°λ λ°μ£ΌκΈ°κ΄ λ²μμμ μ΅μ λΌμ΄λ κ³΅κ³ λ‘ ν΄μλ©λλ€. (default to undefined)
|
|
2040
|
-
let idempotencyKey: string; //λ©±λ±ν€(1~255μ, `[A-Za-z0-9_-]`). **μ¬μλν λλ μ²μκ³Ό κ°μ ν€λ₯Ό 보λ΄μΌ** μ€λ³΅ μμ±μ΄ λ§νλλ€. νμμμΒ·λ€νΈμν¬ μ€λ₯λ‘ λ€μ λΆλ₯΄λ©΄μ μ ν€λ₯Ό λ§λ€λ©΄ λ³κ° μμ²μ΄ λ©λλ€. UUID v4λ₯Ό λ§λ€μ΄ μ°λ μμ€ν
μ μ μ₯νκ±°λ, μμ² λ΄μ©μμ κ²°μ μ μΌλ‘ νμνμΈμ(μ: `bid-create-{ꡬ맀λ²νΈ}`). κ°μ ν€μ κ°μ bodyλ 24μκ° λμ μΊμλ μλ΅μ κ·Έλλ‘ λλ €μ€λλ€. (default to undefined)
|
|
2041
|
-
let submitNegotiationScoresRequestDto: SubmitNegotiationScoresRequestDto; //
|
|
2042
|
-
|
|
2043
|
-
const { status, data } = await apiInstance.submitNegotiationScores(
|
|
2044
|
-
bidRef,
|
|
2045
|
-
idempotencyKey,
|
|
2046
|
-
submitNegotiationScoresRequestDto
|
|
2047
|
-
);
|
|
2048
|
-
```
|
|
2049
|
-
|
|
2050
|
-
### Parameters
|
|
2051
|
-
|
|
2052
|
-
|Name | Type | Description | Notes|
|
|
2053
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2054
|
-
| **submitNegotiationScoresRequestDto** | **SubmitNegotiationScoresRequestDto**| | |
|
|
2055
|
-
| **bidRef** | [**string**] | λ°μ£ΌκΈ°κ΄ μ체 ꡬ맀λ²νΈ(κΆμ₯) λλ c-market κ³΅κ³ λ²νΈ. ꡬ맀λ²νΈλ ν€μ μ°κ²°λ λ°μ£ΌκΈ°κ΄ λ²μμμ μ΅μ λΌμ΄λ κ³΅κ³ λ‘ ν΄μλ©λλ€. | defaults to undefined|
|
|
2056
|
-
| **idempotencyKey** | [**string**] | λ©±λ±ν€(1~255μ, `[A-Za-z0-9_-]`). **μ¬μλν λλ μ²μκ³Ό κ°μ ν€λ₯Ό 보λ΄μΌ** μ€λ³΅ μμ±μ΄ λ§νλλ€. νμμμΒ·λ€νΈμν¬ μ€λ₯λ‘ λ€μ λΆλ₯΄λ©΄μ μ ν€λ₯Ό λ§λ€λ©΄ λ³κ° μμ²μ΄ λ©λλ€. UUID v4λ₯Ό λ§λ€μ΄ μ°λ μμ€ν
μ μ μ₯νκ±°λ, μμ² λ΄μ©μμ κ²°μ μ μΌλ‘ νμνμΈμ(μ: `bid-create-{ꡬ맀λ²νΈ}`). κ°μ ν€μ κ°μ bodyλ 24μκ° λμ μΊμλ μλ΅μ κ·Έλλ‘ λλ €μ€λλ€. | defaults to undefined|
|
|
2057
|
-
|
|
2058
|
-
|
|
2059
|
-
### Return type
|
|
2060
|
-
|
|
2061
|
-
**SubmitNegotiationScores201Response**
|
|
2062
|
-
|
|
2063
|
-
### Authorization
|
|
2064
|
-
|
|
2065
|
-
[partner-oauth2](../README.md#partner-oauth2)
|
|
2066
|
-
|
|
2067
|
-
### HTTP request headers
|
|
2068
|
-
|
|
2069
|
-
- **Content-Type**: application/json
|
|
2070
|
-
- **Accept**: application/json, application/problem+json
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
### HTTP response details
|
|
2074
|
-
| Status code | Description | Response headers |
|
|
2075
|
-
|-------------|-------------|------------------|
|
|
2076
|
-
|**201** | νμ μ μνκ° μλ£. | * RateLimit - νμ¬ μ°½μ μμ¬ μΏΌν°(`r`)μ 리μ
κΉμ§ λ¨μ μ΄(`t`). μ΄ κ°μ΄ 0μ κ°κΉμμ§λ©΄ μμ² κ°κ²©μ λ리μΈμ β 429λ₯Ό λ§λκΈ° μ μ μ‘°μ νλΌκ³ μ£Όλ κ°μ
λλ€. <br> * RateLimit-Policy - μ μ© μ€μΈ μΏΌν° μ μ±
(`q` μμ² μ / `w` μ°½ ν¬κΈ°(μ΄)). λ³νμ§ μμΌλ―λ‘ ν λ² μ½μ΄ λλ©΄ λ©λλ€. <br> |
|
|
2077
|
-
|**400** | μ
λ ₯ κ²μ¦ μ€ν¨(`β¦/validation-failed`), `Idempotency-Key` λλ½Β·νμ μ€λ₯(`β¦/idempotency-key-required`, `β¦/idempotency-key-invalid`), μμ² λ΄μ© μ€λ₯(`β¦/upstream-invalid-input`). | - |
|
|
2078
|
-
|**401** | Bearer ν ν° μμ(`β¦/missing-bearer-token`), λ§λ£Β·μλ³μ‘°Β·νκΈ°(`β¦/invalid-token`). | - |
|
|
2079
|
-
|**403** | ν€ λ―Έλ°μΈλ©(`β¦/unbound-partner-key`), IP μ°¨λ¨(`β¦/ip-not-allowed`), μ€μ½ν λΆμ‘±(`β¦/insufficient-scope`), λν λ²μ λ°(`β¦/buyer-scope-mismatch`), κΆν μμ(`β¦/upstream-forbidden`). | - |
|
|
2080
|
-
|**409** | κ°μ `Idempotency-Key`μ μ μμ²μ΄ μ²λ¦¬ μ€(`β¦/idempotency-key-conflict`), λλ νμ¬ μνμ μΆ©λ(`β¦/upstream-conflict`). μμ κ²½μ° μ μ ν κ°μ ν€λ‘ μ¬μλνλ©΄ κ²°κ³Όλ₯Ό λ°μ΅λλ€. | - |
|
|
2081
|
-
|**422** | κ°μ `Idempotency-Key`λ₯Ό λ€λ₯Έ bodyλ‘ μ¬μ μ‘(`β¦/idempotency-key-reused`), λλ λ΄μ©μ μ²λ¦¬ λΆκ°(`β¦/upstream-unprocessable`). μ¬μλν΄λ κ°μ μ€ν¨μ΄λ―λ‘ μ ν€λ₯Ό μ°κ±°λ bodyλ₯Ό λλ립λλ€. | - |
|
|
2082
|
-
|**429** | μμ² νλ μ΄κ³Ό(`β¦/too-many-requests`). νλλ `client_id`λΉ λΆλΉ 60ν. λκΈ° μκ°μ `Retry-After`(μ΄), μμ¬ μΏΌν°λ `RateLimit`Β·`RateLimit-Policy` ν€λμ μ€λ¦½λλ€. `retryable: true`. | * Retry-After - μ¬μλκΉμ§ λκΈ°ν μ΄. <br> * RateLimit - νμ¬ μ°½μ μμ¬ μΏΌν°. μ: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - μ μ© μ€μΈ μΏΌν° μ μ±
(`q` μμ² μ / `w` μ°½ ν¬κΈ°(μ΄)). λ³νμ§ μμΌλ―λ‘ ν λ² μ½μ΄ λλ©΄ λ©λλ€. <br> |
|
|
2083
|
-
|**500** | μλ² λ΄λΆ μ€λ₯(`β¦/internal-server-error`). `retryable: true`. | - |
|
|
2084
|
-
|**502** | μμ² μ²λ¦¬ μ€ν¨(`β¦/upstream-rejected`). `retryable: true`. | - |
|
|
2085
|
-
|**503** | μΌμμ μ²λ¦¬ λΆκ°(`β¦/service-unavailable`). `Retry-After` ν€λλ₯Ό λ°λ¦
λλ€. `retryable: true`. | * Retry-After - μ¬μλκΉμ§ λκΈ°ν μ΄. <br> |
|
|
2086
|
-
|
|
2087
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2088
|
-
|
|
2089
2021
|
# **updateBid**
|
|
2090
2022
|
> UpdateBid200Response updateBid(updateBidRequestDto)
|
|
2091
2023
|
|
package/index.ts
CHANGED
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
package/models/bid-bond-dto.ts
CHANGED
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|
|
@@ -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: 43.0.1
|
|
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).
|