create-entity-app-server 0.0.3
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/.env.example +68 -0
- package/.gitignore +8 -0
- package/LICENSE +66 -0
- package/README.md +36 -0
- package/bin/create.js +222 -0
- package/configs/cache.json +7 -0
- package/configs/cors.json +24 -0
- package/configs/database.json +30 -0
- package/configs/security.json +45 -0
- package/configs/server.json +31 -0
- package/docs/README.md +274 -0
- package/docs/architecture.md +295 -0
- package/docs/cache.md +217 -0
- package/docs/configs.md +261 -0
- package/docs/database.md +505 -0
- package/docs/design/board-api-design.md +2342 -0
- package/docs/flows.md +581 -0
- package/docs/getting-started.md +83 -0
- package/docs/hooks.md +600 -0
- package/docs/internals.md +60 -0
- package/docs/plugins/2fa.md +121 -0
- package/docs/plugins/alimtalk.md +212 -0
- package/docs/plugins/friendtalk.md +158 -0
- package/docs/plugins/holidays.md +98 -0
- package/docs/plugins/how-to-create.md +148 -0
- package/docs/plugins/identity.md +223 -0
- package/docs/plugins/llm.md +567 -0
- package/docs/plugins/oauth.md +121 -0
- package/docs/plugins/ocr.md +168 -0
- package/docs/plugins/pg.md +226 -0
- package/docs/plugins/push.md +178 -0
- package/docs/plugins/sms.md +228 -0
- package/docs/plugins/taxinvoice.md +197 -0
- package/docs/routes/README.md +247 -0
- package/docs/routes/account-routes.md +262 -0
- package/docs/routes/alimtalk-routes.md +187 -0
- package/docs/routes/board-routes.md +492 -0
- package/docs/routes/email-verification.md +269 -0
- package/docs/routes/friendtalk-routes.md +45 -0
- package/docs/routes/holidays-routes.md +170 -0
- package/docs/routes/how-to-create.md +150 -0
- package/docs/routes/identity-routes.md +310 -0
- package/docs/routes/llm-routes.md +921 -0
- package/docs/routes/ocr-routes.md +133 -0
- package/docs/routes/password-reset.md +234 -0
- package/docs/routes/pg-routes.md +144 -0
- package/docs/routes/push-routes.md +205 -0
- package/docs/routes/sms-routes.md +243 -0
- package/docs/routes/smtp-routes.md +155 -0
- package/docs/routes/tax-invoice-routes.md +109 -0
- package/docs/schedules/dormancy-and-retention.md +160 -0
- package/docs/schedules/how-to-create.md +255 -0
- package/docs/scripts-guide.md +310 -0
- package/docs/security.md +221 -0
- package/docs/system.md +297 -0
- package/package.json +111 -0
- package/scripts/_gen-table-type.ts +605 -0
- package/scripts/build-minify-plugins.mjs +124 -0
- package/scripts/build-obfuscate-system.mjs +38 -0
- package/scripts/build.sh +140 -0
- package/scripts/dist-tsconfig.json +18 -0
- package/scripts/entity.sh +224 -0
- package/scripts/gen-table-type.sh +169 -0
- package/scripts/push.sh +102 -0
- package/scripts/release.sh +51 -0
- package/scripts/reset-all.sh +208 -0
- package/scripts/run.sh +202 -0
- package/src/app/hooks/README.md +148 -0
- package/src/app/hooks/account.ts +26 -0
- package/src/app/hooks/index.ts +19 -0
- package/src/app/hooks/order.ts +230 -0
- package/src/app/hooks/post.ts +162 -0
- package/src/app/plugins/2fa/config.example.json +15 -0
- package/src/app/plugins/2fa/config.json +17 -0
- package/src/app/plugins/2fa/config.ts +44 -0
- package/src/app/plugins/2fa/docs/README.md +139 -0
- package/src/app/plugins/2fa/entities/account.json +30 -0
- package/src/app/plugins/2fa/handlers/disable.ts +114 -0
- package/src/app/plugins/2fa/handlers/index.ts +11 -0
- package/src/app/plugins/2fa/handlers/recovery.ts +98 -0
- package/src/app/plugins/2fa/handlers/regenerate.ts +99 -0
- package/src/app/plugins/2fa/handlers/setup-verify.ts +121 -0
- package/src/app/plugins/2fa/handlers/setup.ts +92 -0
- package/src/app/plugins/2fa/handlers/status.ts +47 -0
- package/src/app/plugins/2fa/handlers/utils.ts +222 -0
- package/src/app/plugins/2fa/handlers/verify.ts +92 -0
- package/src/app/plugins/2fa/index.ts +50 -0
- package/src/app/plugins/2fa/routes.ts +49 -0
- package/src/app/plugins/2fa/templates/auth/2fa_disabled.html +23 -0
- package/src/app/plugins/2fa/templates/auth/2fa_recovery_regenerated.html +31 -0
- package/src/app/plugins/2fa/templates/auth/2fa_setup_complete.html +43 -0
- package/src/app/plugins/2fa/totp-utils.ts +189 -0
- package/src/app/plugins/2fa/types.ts +95 -0
- package/src/app/plugins/README.md +118 -0
- package/src/app/plugins/ais/config.json +7 -0
- package/src/app/plugins/ais/config.ts +32 -0
- package/src/app/plugins/ais/docs/README.md +142 -0
- package/src/app/plugins/ais/docs/api.md +138 -0
- package/src/app/plugins/ais/entities/ais_vessel.json +64 -0
- package/src/app/plugins/ais/handlers.ts +88 -0
- package/src/app/plugins/ais/index.ts +21 -0
- package/src/app/plugins/ais/routes.ts +13 -0
- package/src/app/plugins/ais/service.ts +242 -0
- package/src/app/plugins/ais/types/index.ts +78 -0
- package/src/app/plugins/alimtalk/config.example.json +52 -0
- package/src/app/plugins/alimtalk/config.json +26 -0
- package/src/app/plugins/alimtalk/config.ts +75 -0
- package/src/app/plugins/alimtalk/docs/README.md +140 -0
- package/src/app/plugins/alimtalk/entities/alimtalk_log.json +65 -0
- package/src/app/plugins/alimtalk/entities/alimtalk_msg.json +53 -0
- package/src/app/plugins/alimtalk/entity-adapter.ts +196 -0
- package/src/app/plugins/alimtalk/handlers.ts +84 -0
- package/src/app/plugins/alimtalk/index.ts +80 -0
- package/src/app/plugins/alimtalk/providers/aligo.ts +151 -0
- package/src/app/plugins/alimtalk/providers/index.ts +29 -0
- package/src/app/plugins/alimtalk/providers/nhn.ts +254 -0
- package/src/app/plugins/alimtalk/providers/ppurio.ts +145 -0
- package/src/app/plugins/alimtalk/providers/solapi.ts +145 -0
- package/src/app/plugins/alimtalk/routes.ts +15 -0
- package/src/app/plugins/alimtalk/service.ts +423 -0
- package/src/app/plugins/alimtalk/template-cache.ts +42 -0
- package/src/app/plugins/alimtalk/templates/alimtalk.json +27 -0
- package/src/app/plugins/alimtalk/types/client.ts +48 -0
- package/src/app/plugins/alimtalk/types/config.ts +53 -0
- package/src/app/plugins/alimtalk/types/friendtalk.ts +90 -0
- package/src/app/plugins/alimtalk/types/index.ts +4 -0
- package/src/app/plugins/alimtalk/types/job.ts +56 -0
- package/src/app/plugins/alimtalk/webhook.ts +211 -0
- package/src/app/plugins/distance-server/config.json +6 -0
- package/src/app/plugins/distance-server/config.ts +50 -0
- package/src/app/plugins/distance-server/docs/README.md +114 -0
- package/src/app/plugins/distance-server/handlers.ts +104 -0
- package/src/app/plugins/distance-server/index.ts +23 -0
- package/src/app/plugins/distance-server/routes.ts +36 -0
- package/src/app/plugins/distance-server/service.ts +187 -0
- package/src/app/plugins/distance-server/types/index.ts +8 -0
- package/src/app/plugins/example/config.json +6 -0
- package/src/app/plugins/example/config.ts +46 -0
- package/src/app/plugins/example/docs/README.md +64 -0
- package/src/app/plugins/example/entity-adapter.ts +96 -0
- package/src/app/plugins/example/handlers.ts +94 -0
- package/src/app/plugins/example/index.ts +63 -0
- package/src/app/plugins/example/routes.ts +30 -0
- package/src/app/plugins/example/service.ts +31 -0
- package/src/app/plugins/example/types/config.ts +11 -0
- package/src/app/plugins/example/types/index.ts +1 -0
- package/src/app/plugins/friendtalk/config.example.json +35 -0
- package/src/app/plugins/friendtalk/config.json +11 -0
- package/src/app/plugins/friendtalk/config.ts +70 -0
- package/src/app/plugins/friendtalk/docs/README.md +110 -0
- package/src/app/plugins/friendtalk/entities/friendtalk_log.json +89 -0
- package/src/app/plugins/friendtalk/entities/friendtalk_msg.json +91 -0
- package/src/app/plugins/friendtalk/entity-adapter.ts +150 -0
- package/src/app/plugins/friendtalk/handlers.ts +56 -0
- package/src/app/plugins/friendtalk/routes.ts +12 -0
- package/src/app/plugins/friendtalk/templates/friendtalk.json +16 -0
- package/src/app/plugins/holidays/config.example.json +6 -0
- package/src/app/plugins/holidays/config.json +10 -0
- package/src/app/plugins/holidays/config.ts +44 -0
- package/src/app/plugins/holidays/docs/README.md +122 -0
- package/src/app/plugins/holidays/entities/holiday.json +22 -0
- package/src/app/plugins/holidays/handlers.ts +135 -0
- package/src/app/plugins/holidays/index.ts +78 -0
- package/src/app/plugins/holidays/routes.ts +18 -0
- package/src/app/plugins/holidays/service.ts +241 -0
- package/src/app/plugins/holidays/types/api.ts +49 -0
- package/src/app/plugins/holidays/types/config.ts +8 -0
- package/src/app/plugins/holidays/types/index.ts +2 -0
- package/src/app/plugins/identity/config.example.json +43 -0
- package/src/app/plugins/identity/config.json +30 -0
- package/src/app/plugins/identity/config.ts +138 -0
- package/src/app/plugins/identity/crypto.ts +51 -0
- package/src/app/plugins/identity/docs/README.md +164 -0
- package/src/app/plugins/identity/entities/account.json +27 -0
- package/src/app/plugins/identity/entities/identity_verification.json +113 -0
- package/src/app/plugins/identity/entity-adapter.ts +242 -0
- package/src/app/plugins/identity/handlers.ts +239 -0
- package/src/app/plugins/identity/index.ts +80 -0
- package/src/app/plugins/identity/providers/danal.ts +150 -0
- package/src/app/plugins/identity/providers/index.ts +38 -0
- package/src/app/plugins/identity/providers/kmc.ts +140 -0
- package/src/app/plugins/identity/providers/nice.ts +304 -0
- package/src/app/plugins/identity/routes.ts +22 -0
- package/src/app/plugins/identity/service.ts +361 -0
- package/src/app/plugins/identity/types/config.ts +35 -0
- package/src/app/plugins/identity/types/index.ts +2 -0
- package/src/app/plugins/identity/types/verification.ts +105 -0
- package/src/app/plugins/kobc_freight/config.json +6 -0
- package/src/app/plugins/kobc_freight/config.ts +28 -0
- package/src/app/plugins/kobc_freight/docs/README.md +316 -0
- package/src/app/plugins/kobc_freight/entities/kobc_freight_entry.json +31 -0
- package/src/app/plugins/kobc_freight/entities/kobc_kcci_entry.json +67 -0
- package/src/app/plugins/kobc_freight/entities/kobc_kpli_entry.json +27 -0
- package/src/app/plugins/kobc_freight/entities/kobc_ncfi_entry.json +99 -0
- package/src/app/plugins/kobc_freight/handlers.ts +283 -0
- package/src/app/plugins/kobc_freight/index.ts +21 -0
- package/src/app/plugins/kobc_freight/routes.ts +39 -0
- package/src/app/plugins/kobc_freight/service.ts +604 -0
- package/src/app/plugins/kobc_freight/types/index.ts +99 -0
- package/src/app/plugins/llm/cache.ts +138 -0
- package/src/app/plugins/llm/chatbot-store.ts +270 -0
- package/src/app/plugins/llm/chunker.ts +96 -0
- package/src/app/plugins/llm/config.example.json +260 -0
- package/src/app/plugins/llm/config.json +71 -0
- package/src/app/plugins/llm/config.ts +99 -0
- package/src/app/plugins/llm/conversation-store.ts +140 -0
- package/src/app/plugins/llm/docs/README.md +120 -0
- package/src/app/plugins/llm/docs/api.md +250 -0
- package/src/app/plugins/llm/document-store.ts +318 -0
- package/src/app/plugins/llm/entities/llm_chatbot.json +66 -0
- package/src/app/plugins/llm/entities/llm_conversation.json +61 -0
- package/src/app/plugins/llm/entities/llm_document.json +67 -0
- package/src/app/plugins/llm/entities/llm_usage.json +51 -0
- package/src/app/plugins/llm/entities/llm_user_profile.json +45 -0
- package/src/app/plugins/llm/handlers.ts +1114 -0
- package/src/app/plugins/llm/index.ts +90 -0
- package/src/app/plugins/llm/profile-store.ts +125 -0
- package/src/app/plugins/llm/providers/anthropic.ts +233 -0
- package/src/app/plugins/llm/providers/azure.ts +267 -0
- package/src/app/plugins/llm/providers/gemini.ts +252 -0
- package/src/app/plugins/llm/providers/index.ts +86 -0
- package/src/app/plugins/llm/providers/ollama.ts +237 -0
- package/src/app/plugins/llm/providers/openai.ts +244 -0
- package/src/app/plugins/llm/routes.ts +73 -0
- package/src/app/plugins/llm/service.ts +965 -0
- package/src/app/plugins/llm/template-loader.ts +135 -0
- package/src/app/plugins/llm/templates/prompts/extract_json.json +8 -0
- package/src/app/plugins/llm/templates/prompts/summarize.json +10 -0
- package/src/app/plugins/llm/templates/prompts/translate.json +10 -0
- package/src/app/plugins/llm/types/chat.ts +96 -0
- package/src/app/plugins/llm/types/chatbot.ts +143 -0
- package/src/app/plugins/llm/types/config.ts +47 -0
- package/src/app/plugins/llm/types/conversation.ts +116 -0
- package/src/app/plugins/llm/types/index.ts +7 -0
- package/src/app/plugins/llm/types/profile.ts +48 -0
- package/src/app/plugins/llm/types/store.ts +50 -0
- package/src/app/plugins/llm/types/usage.ts +27 -0
- package/src/app/plugins/llm/usage-store.ts +64 -0
- package/src/app/plugins/oauth/account/handlers/index.ts +4 -0
- package/src/app/plugins/oauth/account/handlers/link.ts +165 -0
- package/src/app/plugins/oauth/account/handlers/providers-list.ts +49 -0
- package/src/app/plugins/oauth/account/handlers/refresh.ts +92 -0
- package/src/app/plugins/oauth/account/handlers/unlink.ts +105 -0
- package/src/app/plugins/oauth/config.example.json +65 -0
- package/src/app/plugins/oauth/config.json +72 -0
- package/src/app/plugins/oauth/config.ts +182 -0
- package/src/app/plugins/oauth/docs/README.md +160 -0
- package/src/app/plugins/oauth/entities/account_oauth.json +74 -0
- package/src/app/plugins/oauth/handlers/callback.ts +314 -0
- package/src/app/plugins/oauth/handlers/index.ts +2 -0
- package/src/app/plugins/oauth/handlers/redirect.ts +47 -0
- package/src/app/plugins/oauth/index.ts +74 -0
- package/src/app/plugins/oauth/providers/index.ts +530 -0
- package/src/app/plugins/oauth/routes.ts +49 -0
- package/src/app/plugins/oauth/service.ts +14 -0
- package/src/app/plugins/oauth/state.ts +105 -0
- package/src/app/plugins/oauth/types/index.ts +52 -0
- package/src/app/plugins/oauth/upsert.ts +162 -0
- package/src/app/plugins/ocr/cache.ts +50 -0
- package/src/app/plugins/ocr/config.example.json +103 -0
- package/src/app/plugins/ocr/config.json +110 -0
- package/src/app/plugins/ocr/config.ts +126 -0
- package/src/app/plugins/ocr/direction.ts +48 -0
- package/src/app/plugins/ocr/dispatch.ts +130 -0
- package/src/app/plugins/ocr/docs/README.md +125 -0
- package/src/app/plugins/ocr/docs/api.md +159 -0
- package/src/app/plugins/ocr/entities/ocr_result.json +98 -0
- package/src/app/plugins/ocr/entities/ocr_usage.json +57 -0
- package/src/app/plugins/ocr/entity-adapter.ts +198 -0
- package/src/app/plugins/ocr/errors.ts +42 -0
- package/src/app/plugins/ocr/handlers.ts +250 -0
- package/src/app/plugins/ocr/index.ts +68 -0
- package/src/app/plugins/ocr/llm-parser.ts +164 -0
- package/src/app/plugins/ocr/parsing-pipeline.ts +87 -0
- package/src/app/plugins/ocr/pdf-converter.ts +136 -0
- package/src/app/plugins/ocr/preprocessor.ts +313 -0
- package/src/app/plugins/ocr/providers/aws.ts +200 -0
- package/src/app/plugins/ocr/providers/azure.ts +183 -0
- package/src/app/plugins/ocr/providers/google.ts +155 -0
- package/src/app/plugins/ocr/providers/index.ts +80 -0
- package/src/app/plugins/ocr/providers/naver.ts +186 -0
- package/src/app/plugins/ocr/providers/tesseract.ts +198 -0
- package/src/app/plugins/ocr/providers/upstage.ts +156 -0
- package/src/app/plugins/ocr/quota.ts +108 -0
- package/src/app/plugins/ocr/refiner.ts +112 -0
- package/src/app/plugins/ocr/routes.ts +19 -0
- package/src/app/plugins/ocr/service.ts +333 -0
- package/src/app/plugins/ocr/template-loader.ts +72 -0
- package/src/app/plugins/ocr/template-matcher.ts +422 -0
- package/src/app/plugins/ocr/templates/business_reg.json +145 -0
- package/src/app/plugins/ocr/templates/career_cert.json +93 -0
- package/src/app/plugins/ocr/templates/driver_license.json +89 -0
- package/src/app/plugins/ocr/templates/facility_card.json +82 -0
- package/src/app/plugins/ocr/templates/id_card.json +55 -0
- package/src/app/plugins/ocr/templates/invoice.json +92 -0
- package/src/app/plugins/ocr/templates/namecard.json +116 -0
- package/src/app/plugins/ocr/templates/prompts/business_reg.json +14 -0
- package/src/app/plugins/ocr/templates/prompts/career_cert.json +16 -0
- package/src/app/plugins/ocr/templates/prompts/driver_license.json +14 -0
- package/src/app/plugins/ocr/templates/prompts/facility_card.json +15 -0
- package/src/app/plugins/ocr/templates/prompts/general.json +13 -0
- package/src/app/plugins/ocr/templates/prompts/id_card.json +11 -0
- package/src/app/plugins/ocr/templates/prompts/invoice.json +17 -0
- package/src/app/plugins/ocr/templates/prompts/namecard.json +15 -0
- package/src/app/plugins/ocr/templates/prompts/receipt.json +14 -0
- package/src/app/plugins/ocr/templates/receipt.json +79 -0
- package/src/app/plugins/ocr/types/config.ts +60 -0
- package/src/app/plugins/ocr/types/driver.ts +71 -0
- package/src/app/plugins/ocr/types/index.ts +5 -0
- package/src/app/plugins/ocr/types/parsed.ts +101 -0
- package/src/app/plugins/ocr/types/store.ts +70 -0
- package/src/app/plugins/ocr/types/template.ts +89 -0
- package/src/app/plugins/ocr/utils.ts +18 -0
- package/src/app/plugins/pg/config.example.json +79 -0
- package/src/app/plugins/pg/config.json +35 -0
- package/src/app/plugins/pg/config.ts +58 -0
- package/src/app/plugins/pg/docs/README.md +176 -0
- package/src/app/plugins/pg/entities/pg_cancel.json +60 -0
- package/src/app/plugins/pg/entities/pg_order.json +115 -0
- package/src/app/plugins/pg/entities/pg_webhook_log.json +52 -0
- package/src/app/plugins/pg/entity-adapter.ts +144 -0
- package/src/app/plugins/pg/handlers.ts +240 -0
- package/src/app/plugins/pg/index.ts +98 -0
- package/src/app/plugins/pg/providers/danal.ts +178 -0
- package/src/app/plugins/pg/providers/hecto.ts +340 -0
- package/src/app/plugins/pg/providers/index.ts +53 -0
- package/src/app/plugins/pg/providers/inicis.ts +151 -0
- package/src/app/plugins/pg/providers/kakaopay.ts +242 -0
- package/src/app/plugins/pg/providers/kcp.ts +147 -0
- package/src/app/plugins/pg/providers/naverpay.ts +299 -0
- package/src/app/plugins/pg/providers/payco.ts +290 -0
- package/src/app/plugins/pg/providers/payletter.ts +377 -0
- package/src/app/plugins/pg/providers/paypal.ts +423 -0
- package/src/app/plugins/pg/providers/toss.ts +157 -0
- package/src/app/plugins/pg/providers/wanna.ts +163 -0
- package/src/app/plugins/pg/routes.ts +31 -0
- package/src/app/plugins/pg/service.ts +531 -0
- package/src/app/plugins/pg/types/client.ts +52 -0
- package/src/app/plugins/pg/types/config.ts +42 -0
- package/src/app/plugins/pg/types/error.ts +25 -0
- package/src/app/plugins/pg/types/index.ts +4 -0
- package/src/app/plugins/pg/types/payment.ts +145 -0
- package/src/app/plugins/providers/docs/README.md +32 -0
- package/src/app/plugins/providers/solapi-auth.ts +27 -0
- package/src/app/plugins/push/config.example.json +26 -0
- package/src/app/plugins/push/config.json +18 -0
- package/src/app/plugins/push/config.ts +119 -0
- package/src/app/plugins/push/docs/README.md +147 -0
- package/src/app/plugins/push/entities/push_log.json +86 -0
- package/src/app/plugins/push/entities/push_msg.json +56 -0
- package/src/app/plugins/push/entity-adapter.ts +326 -0
- package/src/app/plugins/push/handlers.ts +193 -0
- package/src/app/plugins/push/index.ts +85 -0
- package/src/app/plugins/push/providers/apns.ts +152 -0
- package/src/app/plugins/push/providers/fcm.ts +181 -0
- package/src/app/plugins/push/providers/index.ts +42 -0
- package/src/app/plugins/push/providers/utils.ts +30 -0
- package/src/app/plugins/push/routes.ts +24 -0
- package/src/app/plugins/push/service.ts +297 -0
- package/src/app/plugins/push/types/config.ts +32 -0
- package/src/app/plugins/push/types/index.ts +14 -0
- package/src/app/plugins/push/types/job.ts +79 -0
- package/src/app/plugins/shared/docs/README.md +11 -0
- package/src/app/plugins/sms/config.example.json +30 -0
- package/src/app/plugins/sms/config.json +33 -0
- package/src/app/plugins/sms/config.ts +158 -0
- package/src/app/plugins/sms/docs/README.md +236 -0
- package/src/app/plugins/sms/entities/sms_log.json +65 -0
- package/src/app/plugins/sms/entities/sms_msg.json +82 -0
- package/src/app/plugins/sms/entities/sms_verification.json +50 -0
- package/src/app/plugins/sms/entity-adapter.ts +213 -0
- package/src/app/plugins/sms/handlers.ts +149 -0
- package/src/app/plugins/sms/index.ts +93 -0
- package/src/app/plugins/sms/providers/aligo.ts +73 -0
- package/src/app/plugins/sms/providers/aws-sns.ts +182 -0
- package/src/app/plugins/sms/providers/index.ts +47 -0
- package/src/app/plugins/sms/providers/nhn.ts +82 -0
- package/src/app/plugins/sms/providers/ppurio.ts +76 -0
- package/src/app/plugins/sms/providers/solapi.ts +83 -0
- package/src/app/plugins/sms/routes.ts +23 -0
- package/src/app/plugins/sms/service.ts +239 -0
- package/src/app/plugins/sms/types/client.ts +41 -0
- package/src/app/plugins/sms/types/config.ts +46 -0
- package/src/app/plugins/sms/types/index.ts +3 -0
- package/src/app/plugins/sms/types/job.ts +51 -0
- package/src/app/plugins/sms/verification.ts +162 -0
- package/src/app/plugins/smtp/config.json +5 -0
- package/src/app/plugins/smtp/config.ts +41 -0
- package/src/app/plugins/smtp/docs/README.md +165 -0
- package/src/app/plugins/smtp/handlers.ts +52 -0
- package/src/app/plugins/smtp/index.ts +33 -0
- package/src/app/plugins/smtp/routes.ts +19 -0
- package/src/app/plugins/smtp/templates/layout.html +50 -0
- package/src/app/plugins/smtp/types/config.ts +8 -0
- package/src/app/plugins/smtp/types/index.ts +1 -0
- package/src/app/plugins/taxinvoice/config.example.json +60 -0
- package/src/app/plugins/taxinvoice/config.json +35 -0
- package/src/app/plugins/taxinvoice/config.ts +117 -0
- package/src/app/plugins/taxinvoice/docs/README.md +322 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice.json +229 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice_item.json +56 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice_log.json +50 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice_party.json +61 -0
- package/src/app/plugins/taxinvoice/entity-adapter.ts +285 -0
- package/src/app/plugins/taxinvoice/handlers.ts +120 -0
- package/src/app/plugins/taxinvoice/index.ts +74 -0
- package/src/app/plugins/taxinvoice/providers/barobill.ts +273 -0
- package/src/app/plugins/taxinvoice/providers/bolta.ts +193 -0
- package/src/app/plugins/taxinvoice/providers/esero.ts +201 -0
- package/src/app/plugins/taxinvoice/providers/index.ts +41 -0
- package/src/app/plugins/taxinvoice/providers/popbill.ts +258 -0
- package/src/app/plugins/taxinvoice/providers/sendbill.ts +443 -0
- package/src/app/plugins/taxinvoice/providers/smartbill.ts +234 -0
- package/src/app/plugins/taxinvoice/routes.ts +17 -0
- package/src/app/plugins/taxinvoice/service.ts +439 -0
- package/src/app/plugins/taxinvoice/types/client.ts +57 -0
- package/src/app/plugins/taxinvoice/types/config.ts +42 -0
- package/src/app/plugins/taxinvoice/types/index.ts +4 -0
- package/src/app/plugins/taxinvoice/types/invoice.ts +128 -0
- package/src/app/plugins/taxinvoice/types/queue.ts +22 -0
- package/src/app/plugins/vessel_kr/config.json +9 -0
- package/src/app/plugins/vessel_kr/config.ts +32 -0
- package/src/app/plugins/vessel_kr/docs/README.md +167 -0
- package/src/app/plugins/vessel_kr/entities/vessel_kr_entry.json +136 -0
- package/src/app/plugins/vessel_kr/handlers.ts +102 -0
- package/src/app/plugins/vessel_kr/index.ts +21 -0
- package/src/app/plugins/vessel_kr/routes.ts +15 -0
- package/src/app/plugins/vessel_kr/service.ts +264 -0
- package/src/app/plugins/vessel_kr/types/index.ts +100 -0
- package/src/app/routes/README.md +71 -0
- package/src/app/routes/account/change-password/config.json +5 -0
- package/src/app/routes/account/change-password/entities/password_history.json +18 -0
- package/src/app/routes/account/change-password/handlers.ts +204 -0
- package/src/app/routes/account/change-password/routes.ts +28 -0
- package/src/app/routes/account/config.json +5 -0
- package/src/app/routes/account/reactivate/config.json +5 -0
- package/src/app/routes/account/reactivate/handlers.ts +249 -0
- package/src/app/routes/account/reactivate/routes.ts +14 -0
- package/src/app/routes/account/register/config-loader.ts +34 -0
- package/src/app/routes/account/register/config.json +8 -0
- package/src/app/routes/account/register/handlers.ts +207 -0
- package/src/app/routes/account/register/routes.ts +25 -0
- package/src/app/routes/account/register/types/index.ts +50 -0
- package/src/app/routes/account/routes.ts +31 -0
- package/src/app/routes/account/templates/force_reset.html +18 -0
- package/src/app/routes/account/templates/welcome.html +14 -0
- package/src/app/routes/account/withdraw/handlers.ts +111 -0
- package/src/app/routes/account/withdraw/routes.ts +18 -0
- package/src/app/routes/approval/config.json +5 -0
- package/src/app/routes/approval/entities/approval.json +99 -0
- package/src/app/routes/approval/entities/comments.json +17 -0
- package/src/app/routes/approval/entities/reference.json +16 -0
- package/src/app/routes/approval/routes.ts +30 -0
- package/src/app/routes/auth/config.json +5 -0
- package/src/app/routes/auth/handlers.ts +245 -0
- package/src/app/routes/auth/routes.ts +16 -0
- package/src/app/routes/board/config.json +5 -0
- package/src/app/routes/board/entities/board_category.json +90 -0
- package/src/app/routes/board/entities/board_comment.json +83 -0
- package/src/app/routes/board/entities/board_like.json +51 -0
- package/src/app/routes/board/entities/board_mention.json +50 -0
- package/src/app/routes/board/entities/board_post.json +148 -0
- package/src/app/routes/board/entities/board_post_tag.json +41 -0
- package/src/app/routes/board/entities/board_rating.json +127 -0
- package/src/app/routes/board/entities/board_read_log.json +29 -0
- package/src/app/routes/board/entities/board_report.json +53 -0
- package/src/app/routes/board/entities/board_tag.json +21 -0
- package/src/app/routes/board/handlers/categories.ts +134 -0
- package/src/app/routes/board/handlers/comments.ts +207 -0
- package/src/app/routes/board/handlers/files.ts +104 -0
- package/src/app/routes/board/handlers/likes.ts +31 -0
- package/src/app/routes/board/handlers/mentions.ts +54 -0
- package/src/app/routes/board/handlers/posts.ts +577 -0
- package/src/app/routes/board/handlers/ratings.ts +60 -0
- package/src/app/routes/board/handlers/reports.ts +131 -0
- package/src/app/routes/board/handlers/tags.ts +81 -0
- package/src/app/routes/board/routes.ts +137 -0
- package/src/app/routes/calendar/config.json +5 -0
- package/src/app/routes/calendar/entities/calendar_attendees.json +23 -0
- package/src/app/routes/calendar/entities/calendar_comments.json +17 -0
- package/src/app/routes/calendar/entities/calendar_events.json +48 -0
- package/src/app/routes/calendar/entities/calendar_kind.json +11 -0
- package/src/app/routes/calendar/entities/calendar_method.json +11 -0
- package/src/app/routes/calendar/routes.ts +32 -0
- package/src/app/routes/email-verify/config-loader.ts +47 -0
- package/src/app/routes/email-verify/config.example.json +13 -0
- package/src/app/routes/email-verify/config.json +16 -0
- package/src/app/routes/email-verify/entities/account.json +23 -0
- package/src/app/routes/email-verify/handlers/activate.ts +103 -0
- package/src/app/routes/email-verify/handlers/change.ts +106 -0
- package/src/app/routes/email-verify/handlers/confirm.ts +87 -0
- package/src/app/routes/email-verify/handlers/index.ts +20 -0
- package/src/app/routes/email-verify/handlers/send.ts +157 -0
- package/src/app/routes/email-verify/handlers/status.ts +53 -0
- package/src/app/routes/email-verify/handlers/utils.ts +85 -0
- package/src/app/routes/email-verify/routes.ts +54 -0
- package/src/app/routes/email-verify/templates/verification.html +15 -0
- package/src/app/routes/email-verify/templates/verification_link.html +19 -0
- package/src/app/routes/email-verify/types/index.ts +77 -0
- package/src/app/routes/email-verify/verification-utils.ts +57 -0
- package/src/app/routes/example-db/config.json +5 -0
- package/src/app/routes/example-db/handlers.ts +220 -0
- package/src/app/routes/example-db/models/account-ext.ts +33 -0
- package/src/app/routes/example-db/models/users.ts +30 -0
- package/src/app/routes/example-db/routes.ts +23 -0
- package/src/app/routes/example-db/types/defaults.ts +21 -0
- package/src/app/routes/example-db/types/index.ts +4 -0
- package/src/app/routes/example-db/types/params.ts +3 -0
- package/src/app/routes/example-db/types/query.ts +6 -0
- package/src/app/routes/example-db/types/user.ts +11 -0
- package/src/app/routes/example-es/config.json +5 -0
- package/src/app/routes/example-es/handlers.ts +216 -0
- package/src/app/routes/example-es/routes.ts +24 -0
- package/src/app/routes/example-es/types/defaults.ts +30 -0
- package/src/app/routes/example-es/types/index.ts +4 -0
- package/src/app/routes/example-es/types/params.ts +3 -0
- package/src/app/routes/example-es/types/post.ts +12 -0
- package/src/app/routes/example-es/types/query.ts +14 -0
- package/src/app/routes/funeral/config.json +5 -0
- package/src/app/routes/funeral/entities/funeral.json +77 -0
- package/src/app/routes/funeral/entities/funeral_docs.json +36 -0
- package/src/app/routes/funeral/entities/funeral_mourner.json +31 -0
- package/src/app/routes/funeral/entities/funeral_order.json +48 -0
- package/src/app/routes/funeral/entities/funeral_room.json +61 -0
- package/src/app/routes/funeral/entities/funeral_schedule.json +39 -0
- package/src/app/routes/funeral/routes.ts +32 -0
- package/src/app/routes/health/config.json +5 -0
- package/src/app/routes/health/handlers.ts +69 -0
- package/src/app/routes/health/routes.ts +14 -0
- package/src/app/routes/hr/career/config.json +5 -0
- package/src/app/routes/hr/career/entities/employee_career.json +15 -0
- package/src/app/routes/hr/career/routes.ts +25 -0
- package/src/app/routes/hr/config.json +5 -0
- package/src/app/routes/hr/education/config.json +5 -0
- package/src/app/routes/hr/education/entities/employee_education.json +29 -0
- package/src/app/routes/hr/education/entities/employee_education_mans.json +25 -0
- package/src/app/routes/hr/education/entities/employee_school.json +19 -0
- package/src/app/routes/hr/education/routes.ts +28 -0
- package/src/app/routes/hr/employee/config.json +5 -0
- package/src/app/routes/hr/employee/entities/employee.json +59 -0
- package/src/app/routes/hr/employee/entities/employee_cert.json +19 -0
- package/src/app/routes/hr/employee/entities/employee_reward.json +21 -0
- package/src/app/routes/hr/employee/routes.ts +27 -0
- package/src/app/routes/hr/entities/hr_group.json +47 -0
- package/src/app/routes/hr/entities/hr_group_pv.json +20 -0
- package/src/app/routes/hr/entities/hr_role.json +43 -0
- package/src/app/routes/hr/entities/hr_role_pv.json +20 -0
- package/src/app/routes/hr/routes.ts +29 -0
- package/src/app/routes/messages/chat/config.json +5 -0
- package/src/app/routes/messages/chat/entities/user_chat.json +47 -0
- package/src/app/routes/messages/chat/entities/user_chat_room.json +38 -0
- package/src/app/routes/messages/chat/entities/user_chat_room_member.json +49 -0
- package/src/app/routes/messages/chat/routes.ts +28 -0
- package/src/app/routes/messages/msgbox/config.json +5 -0
- package/src/app/routes/messages/msgbox/entities/user_msgbox.json +73 -0
- package/src/app/routes/messages/msgbox/routes.ts +28 -0
- package/src/app/routes/password-reset/config.example.json +13 -0
- package/src/app/routes/password-reset/config.json +15 -0
- package/src/app/routes/password-reset/entities/account.json +13 -0
- package/src/app/routes/password-reset/handlers.ts +335 -0
- package/src/app/routes/password-reset/password-utils.ts +96 -0
- package/src/app/routes/password-reset/routes.ts +84 -0
- package/src/app/routes/password-reset/templates/password_reset.html +21 -0
- package/src/app/routes/password-reset/templates/password_reset_link.html +19 -0
- package/src/app/routes/password-reset/types/index.ts +95 -0
- package/src/app/routes/privilege/config.json +5 -0
- package/src/app/routes/privilege/entities/pv_group.json +29 -0
- package/src/app/routes/privilege/entities/pv_group_item.json +31 -0
- package/src/app/routes/privilege/entities/pv_item.json +176 -0
- package/src/app/routes/privilege/entities/user_pv_group.json +20 -0
- package/src/app/routes/privilege/entities/user_pv_item.json +20 -0
- package/src/app/routes/privilege/routes.ts +33 -0
- package/src/app/routes/user/config.json +5 -0
- package/src/app/routes/user/entities/user.json +64 -0
- package/src/app/routes/user/entities/user_biometric.json +28 -0
- package/src/app/routes/user/routes.ts +27 -0
- package/src/app/routes/vessel-tracking/config.json +3 -0
- package/src/app/routes/vessel-tracking/entities/tracked_vessel.json +261 -0
- package/src/app/routes/vessel-tracking/handlers.ts +134 -0
- package/src/app/routes/vessel-tracking/routes.ts +25 -0
- package/src/app/routes/vessel-tracking/types/index.ts +5 -0
- package/src/app/routes/vessel-tracking/types/vessel.ts +59 -0
- package/src/app/schedules/README.md +105 -0
- package/src/app/schedules/ais_sync/config.json +4 -0
- package/src/app/schedules/ais_sync/index.ts +69 -0
- package/src/app/schedules/data-retention/config.json +9 -0
- package/src/app/schedules/data-retention/index.ts +238 -0
- package/src/app/schedules/dormancy/config.json +15 -0
- package/src/app/schedules/dormancy/entities/account.json +14 -0
- package/src/app/schedules/dormancy/entities/privacy_cron_lock.json +23 -0
- package/src/app/schedules/dormancy/index.ts +289 -0
- package/src/app/schedules/dormancy/templates/dormancy_completed.html +21 -0
- package/src/app/schedules/dormancy/templates/dormancy_warning.html +20 -0
- package/src/app/schedules/kobc_freight_sync/config.json +4 -0
- package/src/app/schedules/kobc_freight_sync/index.ts +94 -0
- package/src/app/schedules/vessel_kr_sync/config.json +4 -0
- package/src/app/schedules/vessel_kr_sync/index.ts +72 -0
- package/src/system/app.ts +129 -0
- package/src/system/cache/_store-ref.ts +15 -0
- package/src/system/cache/config.ts +61 -0
- package/src/system/cache/drivers/memcached.ts +135 -0
- package/src/system/cache/drivers/memory.ts +92 -0
- package/src/system/cache/drivers/redis.ts +109 -0
- package/src/system/cache/index.ts +43 -0
- package/src/system/cache/namespaced.ts +79 -0
- package/src/system/cache/plugin.ts +59 -0
- package/src/system/cache/types.ts +81 -0
- package/src/system/config/config-path.ts +20 -0
- package/src/system/config/cors.ts +49 -0
- package/src/system/config/database.ts +190 -0
- package/src/system/config/entity-server.ts +8 -0
- package/src/system/config/env-substitution.ts +4 -0
- package/src/system/config/env.ts +30 -0
- package/src/system/config/json-config.ts +13 -0
- package/src/system/config/module-path.ts +16 -0
- package/src/system/config/packet-encrypt.ts +80 -0
- package/src/system/config/rate-limit.ts +4 -0
- package/src/system/config/security-loader.ts +25 -0
- package/src/system/config/security.ts +16 -0
- package/src/system/config/server.ts +81 -0
- package/src/system/crypto/cipher.ts +117 -0
- package/src/system/crypto/data-encrypt.ts +174 -0
- package/src/system/crypto/hash.ts +24 -0
- package/src/system/crypto/packet.test.ts +23 -0
- package/src/system/crypto/packet.ts +97 -0
- package/src/system/crypto/random.ts +19 -0
- package/src/system/email/sender.ts +85 -0
- package/src/system/email/template-engine.ts +147 -0
- package/src/system/entity-server/bootstrap.ts +270 -0
- package/src/system/entity-server/client.ts +64 -0
- package/src/system/hooks/loader.ts +32 -0
- package/src/system/hooks/runner.ts +159 -0
- package/src/system/hooks/types.ts +75 -0
- package/src/system/hooks/withdraw-hooks.ts +42 -0
- package/src/system/http/cookie.ts +62 -0
- package/src/system/http/response.ts +16 -0
- package/src/system/index.ts +48 -0
- package/src/system/logging/log-format.ts +50 -0
- package/src/system/logging/logger.ts +104 -0
- package/src/system/middleware/_db-ref.ts +26 -0
- package/src/system/middleware/_push-ref.ts +28 -0
- package/src/system/middleware/access-log.ts +34 -0
- package/src/system/middleware/auth.ts +67 -0
- package/src/system/middleware/csrf.ts +172 -0
- package/src/system/middleware/database.ts +44 -0
- package/src/system/middleware/error-handler.ts +51 -0
- package/src/system/middleware/extension-loader.ts +111 -0
- package/src/system/middleware/packet-encrypt.ts +281 -0
- package/src/system/middleware/request-id.ts +18 -0
- package/src/system/plugins/access-log.ts +34 -0
- package/src/system/plugins/packet-encrypt.ts +281 -0
- package/src/system/proxy/register.ts +37 -0
- package/src/system/public-api.ts +140 -0
- package/src/system/push/sender.ts +131 -0
- package/src/system/routes/entity-interceptor.ts +327 -0
- package/src/system/routes/loader.ts +215 -0
- package/src/system/scheduler/cron-utils.ts +150 -0
- package/src/system/scheduler/distributed-lock.ts +141 -0
- package/src/system/scheduler/schedule-loader.ts +105 -0
- package/src/system/security/anonymous-device-id.ts +41 -0
- package/src/system/security/anonymous-device.ts +98 -0
- package/src/system/security/anonymous-packet-token.ts +23 -0
- package/src/system/security/packet-bootstrap.ts +16 -0
- package/src/system/security/password-policy.ts +191 -0
- package/src/system/startup-banner.ts +191 -0
- package/src/system/types/fastify.d.ts +53 -0
- package/src/system/utils/app-path.ts +31 -0
- package/src/system/utils/coerce.ts +28 -0
- package/src/system/utils/date-prefixed-log-stream.ts +176 -0
- package/src/system/utils/errors.ts +66 -0
- package/src/system/utils/format.ts +45 -0
- package/src/system/utils/http-client.ts +79 -0
- package/src/system/utils/user-agent.ts +82 -0
- package/tsconfig.app.json +17 -0
- package/tsconfig.json +39 -0
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# SMS 가이드
|
|
2
|
+
|
|
3
|
+
SMS/LMS/MMS 문자 발송 및 본인인증(인증번호) 기능에 대한 설정·운영 가이드입니다.
|
|
4
|
+
|
|
5
|
+
이 문서는 플러그인의 개요/설정/운영 가이드를 중심으로 다룹니다.
|
|
6
|
+
실제 라우트표, 호출 예제, 응답 예제는 [SMS Routes](../routes/sms-routes.md) 문서를 참고하세요.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 목차
|
|
11
|
+
|
|
12
|
+
- [개요](#개요)
|
|
13
|
+
- [프로바이더 비교](#프로바이더-비교)
|
|
14
|
+
- [설정](#설정)
|
|
15
|
+
- [발송 흐름](#발송-흐름)
|
|
16
|
+
- [인증번호(본인인증)](#인증번호본인인증)
|
|
17
|
+
- [엔티티 구조](#엔티티-구조)
|
|
18
|
+
- [운영 팁](#운영-팁)
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 개요
|
|
23
|
+
|
|
24
|
+
SMS 플러그인은 **DB 큐 패턴**으로 문자를 발송합니다. 클라이언트가 발송 요청을 하면
|
|
25
|
+
`sms_log` 엔티티에 `pending` 상태로 저장 → 디스패치 루프가 주기적으로 조회 → 프로바이더 API 호출 → 결과에 따라 `sent`/`failed` 갱신.
|
|
26
|
+
|
|
27
|
+
| 메시지 타입 | 설명 |
|
|
28
|
+
| ----------- | ------------------------------ |
|
|
29
|
+
| SMS | 80byte 이하 단문 |
|
|
30
|
+
| LMS | 80byte 초과 장문 (2,000byte) |
|
|
31
|
+
| MMS | 이미지 첨부 멀티미디어 (300KB) |
|
|
32
|
+
|
|
33
|
+
`auto_lms: true`(기본) 설정 시, 본문 바이트 수에 따라 자동으로 SMS/LMS 판정합니다.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 프로바이더 비교
|
|
38
|
+
|
|
39
|
+
| 항목 | **aligo** | **solapi** | **ppurio** | **nhn_cloud** | **aws_sns** |
|
|
40
|
+
| --------- | ----------------- | --------------------- | ---------------------- | -------------------- | -------------------- |
|
|
41
|
+
| 홈페이지 | aligo.in | solapi.com | ppurio.com | nhncloud.com | aws.amazon.com/sns |
|
|
42
|
+
| SMS 단가 | ~9원 | ~10원 | ~10원 | ~9원 | 종량(건당 ~$0.00645) |
|
|
43
|
+
| 인증 방식 | API Key + User ID | API Key + HMAC-SHA256 | Account + Bearer Token | App Key + Secret Key | AWS Sig V4 |
|
|
44
|
+
| LMS/MMS | ✅ | ✅ | ✅ | ✅ | ❌ (SMS만 지원) |
|
|
45
|
+
| 해외 발송 | ✅ | ✅ | ✅ | ✅ | ✅ (글로벌) |
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## 설정
|
|
50
|
+
|
|
51
|
+
플러그인 디렉토리에 위치한 `config.json`:
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"enabled": true,
|
|
56
|
+
"default": "aligo",
|
|
57
|
+
"sender": "${SMS_SENDER}",
|
|
58
|
+
"workers": 2,
|
|
59
|
+
"queue_size": 200,
|
|
60
|
+
"dispatch_interval_sec": 5,
|
|
61
|
+
"max_retries": 3,
|
|
62
|
+
"auto_lms": true,
|
|
63
|
+
"lms_threshold_bytes": 80,
|
|
64
|
+
"providers": {
|
|
65
|
+
"aligo": {
|
|
66
|
+
"driver": "aligo",
|
|
67
|
+
"api_key": "${ALIGO_API_KEY}",
|
|
68
|
+
"user_id": "${ALIGO_USER_ID}",
|
|
69
|
+
"sender": "${SMS_SENDER}"
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"verification": {
|
|
73
|
+
"code_length": 6,
|
|
74
|
+
"ttl_sec": 180,
|
|
75
|
+
"max_attempts": 5,
|
|
76
|
+
"cooldown_sec": 60
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 주요 설정 항목
|
|
82
|
+
|
|
83
|
+
| 항목 | 기본값 | 설명 |
|
|
84
|
+
| ----------------------- | ------ | -------------------------------- |
|
|
85
|
+
| `enabled` | `true` | 기능 활성화 여부 |
|
|
86
|
+
| `default` | — | 기본 프로바이더 이름 (key, 필수) |
|
|
87
|
+
| `sender` | — | 글로벌 발신번호 |
|
|
88
|
+
| `workers` | `2` | 동시 발송 워커 수 |
|
|
89
|
+
| `queue_size` | `200` | dispatch당 최대 claim 수 |
|
|
90
|
+
| `dispatch_interval_sec` | `5` | 디스패처 폴링 주기(초) |
|
|
91
|
+
| `max_retries` | `3` | 최대 재시도 횟수 |
|
|
92
|
+
| `auto_lms` | `true` | 자동 LMS 판정 활성화 |
|
|
93
|
+
| `lms_threshold_bytes` | `80` | LMS 전환 바이트 임계값 |
|
|
94
|
+
|
|
95
|
+
### 인증번호 설정
|
|
96
|
+
|
|
97
|
+
| 항목 | 기본값 | 설명 |
|
|
98
|
+
| -------------- | ------ | --------------------- |
|
|
99
|
+
| `code_length` | `6` | 인증번호 자릿수 |
|
|
100
|
+
| `ttl_sec` | `180` | 인증번호 유효시간(초) |
|
|
101
|
+
| `max_attempts` | `5` | 최대 인증 시도 횟수 |
|
|
102
|
+
| `cooldown_sec` | `60` | 재발송 대기시간(초) |
|
|
103
|
+
|
|
104
|
+
### 드라이버별 필수 필드
|
|
105
|
+
|
|
106
|
+
| Driver | 필수 필드 |
|
|
107
|
+
| ----------- | ------------------------------------ |
|
|
108
|
+
| `aligo` | `api_key`, `user_id` |
|
|
109
|
+
| `solapi` | `api_key`, `api_secret` |
|
|
110
|
+
| `ppurio` | `account`, `api_key` |
|
|
111
|
+
| `nhn_cloud` | `app_key`, `secret_key` |
|
|
112
|
+
| `aws_sns` | `region`, `access_key`, `secret_key` |
|
|
113
|
+
|
|
114
|
+
### 환경변수 치환
|
|
115
|
+
|
|
116
|
+
설정 파일에서 `${VAR}` 패턴은 `process.env.VAR` 값으로 자동 치환됩니다.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## 발송 흐름
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
클라이언트 → POST /api/v1/sms/send
|
|
124
|
+
↓
|
|
125
|
+
sms_log(pending) DB 저장
|
|
126
|
+
↓
|
|
127
|
+
dispatch loop (N초 주기)
|
|
128
|
+
↓
|
|
129
|
+
pending 조회 → processing 갱신
|
|
130
|
+
↓
|
|
131
|
+
프로바이더 API 호출 (N workers 병렬)
|
|
132
|
+
↓
|
|
133
|
+
sent / failed 상태 갱신
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
1. **enqueue**: `handleSend` → `SmsService.enqueueJob()` → `sms_log` 엔티티에 `pending` 저장
|
|
137
|
+
2. **dispatch**: `setInterval`로 주기적 실행 → `claimPendingSmsLogs()` (pending → processing)
|
|
138
|
+
3. **process**: 워커가 프로바이더 `send()` 호출 → 결과에 따라 `finalize()`
|
|
139
|
+
4. **finalize**: `sent` 또는 `failed` 갱신 + 참조 `sms_msg` 상태 연동
|
|
140
|
+
5. **stale recovery**: 서버 시작 시 `processing` 상태 로그를 `pending`으로 복구 (max_retries 초과 시 `failed`)
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## 인증번호(본인인증)
|
|
145
|
+
|
|
146
|
+
SMS 본인인증은 `verification` 설정이 존재할 때 활성화됩니다.
|
|
147
|
+
|
|
148
|
+
### 흐름
|
|
149
|
+
|
|
150
|
+
1. `POST /api/v1/sms/verification/send` → 이전 pending 만료 → 코드 생성 → SHA-256 해시 저장 → SMS 발송
|
|
151
|
+
2. `POST /api/v1/sms/verification/verify` → pending 조회 → 만료/시도횟수 확인 → constant-time 비교
|
|
152
|
+
|
|
153
|
+
### 보안
|
|
154
|
+
|
|
155
|
+
- 인증번호는 **SHA-256 해시**로만 저장 (평문 미저장)
|
|
156
|
+
- 검증 시 **constant-time comparison** (`timingSafeEqual`) 사용
|
|
157
|
+
- 코드 생성은 `crypto.randomInt()` (암호학적 난수)
|
|
158
|
+
- 불일치 시에만 시도 횟수 증가 (timing attack 방지)
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## 엔티티 구조
|
|
163
|
+
|
|
164
|
+
### sms_log
|
|
165
|
+
|
|
166
|
+
| 필드 | 타입 | 설명 |
|
|
167
|
+
| ----------------- | -------- | ------------------------------ |
|
|
168
|
+
| `seq` | integer | PK |
|
|
169
|
+
| `status` | string | pending/processing/sent/failed |
|
|
170
|
+
| `provider` | string | 프로바이더 driver |
|
|
171
|
+
| `sender` | string | 발신번호 |
|
|
172
|
+
| `receiver` | string | 수신번호 |
|
|
173
|
+
| `content` | text | 본문 |
|
|
174
|
+
| `subject` | string | 제목 (LMS/MMS) |
|
|
175
|
+
| `msg_type` | string | sms/lms/mms |
|
|
176
|
+
| `image_url` | string | MMS 이미지 URL |
|
|
177
|
+
| `provider_msg_id` | string | 프로바이더 메시지 ID |
|
|
178
|
+
| `error_message` | text | 실패 사유 |
|
|
179
|
+
| `retry_count` | integer | 재시도 횟수 |
|
|
180
|
+
| `sent_at` | datetime | 발송 완료 시각 |
|
|
181
|
+
|
|
182
|
+
### sms_verification
|
|
183
|
+
|
|
184
|
+
| 필드 | 타입 | 설명 |
|
|
185
|
+
| ------------ | -------- | ------------------------ |
|
|
186
|
+
| `seq` | integer | PK |
|
|
187
|
+
| `phone` | string | 전화번호 |
|
|
188
|
+
| `purpose` | string | 용도 (signup, reset 등) |
|
|
189
|
+
| `status` | string | pending/verified/expired |
|
|
190
|
+
| `code_hash` | string | SHA-256 해시 |
|
|
191
|
+
| `expires_at` | datetime | 만료 시각 |
|
|
192
|
+
| `attempts` | integer | 시도 횟수 |
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## 운영 팁
|
|
197
|
+
|
|
198
|
+
### 발신번호 사전등록
|
|
199
|
+
|
|
200
|
+
국내 SMS 서비스는 **발신번호 사전등록**이 필수입니다. 아래 각 프로바이더 콘솔에서 등록 후 `sender` 필드에 설정하세요.
|
|
201
|
+
|
|
202
|
+
| 프로바이더 | 발신번호 등록 페이지 |
|
|
203
|
+
| ---------- | ----------------------------------------------------------------- |
|
|
204
|
+
| aligo | https://smartsms.aligo.in/admin/sendnumber/sendnumber_manage.html |
|
|
205
|
+
| solapi | https://console.solapi.com/credentials |
|
|
206
|
+
| ppurio | https://www.ppurio.com/mypage/callbackList |
|
|
207
|
+
| nhn_cloud | https://console.nhncloud.com/SMS |
|
|
208
|
+
| aws_sns | AWS Console → Amazon SNS → Origination numbers |
|
|
209
|
+
|
|
210
|
+
### 프로바이더 fallback
|
|
211
|
+
|
|
212
|
+
`providers` 객체에 여러 프로바이더를 등록하고, 발송 시 `provider` 필드로 교체 가능합니다. 기본은 `default` 프로바이더가 사용됩니다.
|
|
213
|
+
|
|
214
|
+
### 모니터링
|
|
215
|
+
|
|
216
|
+
- `sms_log` 엔티티에서 `status=failed` 필터로 실패 건 확인
|
|
217
|
+
- 로그에서 `SMS:` 접두사로 필터링
|
|
218
|
+
- stale recovery 로그: `SMS: reset N stale processing logs`
|
|
219
|
+
|
|
220
|
+
### Graceful Shutdown
|
|
221
|
+
|
|
222
|
+
서비스 종료 시 진행 중인 dispatch 작업이 완료될 때까지 대기합니다.
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## 관련 문서
|
|
227
|
+
|
|
228
|
+
- [SMS Routes](../routes/sms-routes.md) — API 라우트 레퍼런스
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
# 세금계산서 가이드
|
|
2
|
+
|
|
3
|
+
바로빌, 이세로, 팝빌, 스마트빌, 볼타 등을 통한 전자세금계산서 발급 가이드입니다.
|
|
4
|
+
|
|
5
|
+
이 문서는 플러그인의 개요/설정/운영 가이드를 중심으로 다룹니다.
|
|
6
|
+
실제 라우트표, 호출 예제, 응답 예제는 [Tax Invoice Routes](../routes/tax-invoice-routes.md) 문서를 참고하세요.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 목차
|
|
11
|
+
|
|
12
|
+
- [개요](#개요)
|
|
13
|
+
- [프로바이더 비교](#프로바이더-비교)
|
|
14
|
+
- [설정](#설정)
|
|
15
|
+
- [발급 흐름](#발급-흐름)
|
|
16
|
+
- [API 레퍼런스](#api-레퍼런스)
|
|
17
|
+
- [상태 흐름](#상태-흐름)
|
|
18
|
+
- [국세청 전송](#국세청-전송)
|
|
19
|
+
- [운영 팁](#운영-팁)
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## 개요
|
|
24
|
+
|
|
25
|
+
Gateway의 세금계산서 플러그인은 여러 세금계산서 발급 대행 프로바이더를 단일 API로 추상화합니다.
|
|
26
|
+
|
|
27
|
+
- 즉시 발급 (등록 + 발행 일괄 처리)
|
|
28
|
+
- 단계별 발급 (draft 저장 → 검토 → 발행)
|
|
29
|
+
- 발행 취소
|
|
30
|
+
- 국세청(NTS) 전송 상태 추적
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 프로바이더 비교
|
|
35
|
+
|
|
36
|
+
| provider | driver | 특징 |
|
|
37
|
+
| -------- | ---------- | --------------------------------- |
|
|
38
|
+
| 바로빌 | `barobill` | 국내 점유율 1위, 다양한 연동 방식 |
|
|
39
|
+
| 이지로 | `ezero` | 이지로 전자세금계산서 |
|
|
40
|
+
| 팝빌 | `popbill` | API 문서 풍부, 중소기업 많이 사용 |
|
|
41
|
+
| KT-NET | `ktnet` | KT-NET 세금계산서 서비스 |
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## 설정
|
|
46
|
+
|
|
47
|
+
`configs/plugins/tax-invoice.json`:
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"enabled": false,
|
|
52
|
+
"default": "barobill",
|
|
53
|
+
"providers": {
|
|
54
|
+
"barobill": {
|
|
55
|
+
"driver": "barobill",
|
|
56
|
+
"cert_key": "${TAXINVOICE_CERT_KEY}",
|
|
57
|
+
"corp_num": "${TAXINVOICE_CORP_NUM}",
|
|
58
|
+
"user_id": "${TAXINVOICE_USER_ID}",
|
|
59
|
+
"api_endpoint": "https://barobill.co.kr/TAPI/TaxInvoiceService.asmx"
|
|
60
|
+
},
|
|
61
|
+
"ezero": {
|
|
62
|
+
"driver": "ezero",
|
|
63
|
+
"cert_key": "${EZERO_CERT_KEY}",
|
|
64
|
+
"corp_num": "${EZERO_CORP_NUM}",
|
|
65
|
+
"user_id": "${EZERO_USER_ID}",
|
|
66
|
+
"api_endpoint": "https://www.ezero.co.kr/tax-invoice/api"
|
|
67
|
+
},
|
|
68
|
+
"popbill": {
|
|
69
|
+
"driver": "popbill",
|
|
70
|
+
"link_id": "${POPBILL_LINK_ID}",
|
|
71
|
+
"secret_key": "${POPBILL_SECRET_KEY}",
|
|
72
|
+
"corp_num": "${POPBILL_CORP_NUM}",
|
|
73
|
+
"api_url": "https://www.popbill.com"
|
|
74
|
+
},
|
|
75
|
+
"ktnet": {
|
|
76
|
+
"driver": "ktnet",
|
|
77
|
+
"cert_key": "${KTNET_CERT_KEY}",
|
|
78
|
+
"corp_num": "${KTNET_CORP_NUM}",
|
|
79
|
+
"user_id": "${KTNET_USER_ID}",
|
|
80
|
+
"api_endpoint": "https://www.b2b.kt.com/einvoice"
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 환경변수 (.env)
|
|
87
|
+
|
|
88
|
+
```env
|
|
89
|
+
TAXINVOICE_CERT_KEY=your_cert_key
|
|
90
|
+
TAXINVOICE_CORP_NUM=1234567890
|
|
91
|
+
TAXINVOICE_USER_ID=your_user_id
|
|
92
|
+
|
|
93
|
+
EZERO_CERT_KEY=your_cert_key
|
|
94
|
+
EZERO_CORP_NUM=1234567890
|
|
95
|
+
EZERO_USER_ID=your_user_id
|
|
96
|
+
|
|
97
|
+
POPBILL_LINK_ID=your_link_id
|
|
98
|
+
POPBILL_SECRET_KEY=your_secret_key
|
|
99
|
+
POPBILL_CORP_NUM=1234567890
|
|
100
|
+
|
|
101
|
+
KTNET_CERT_KEY=your_cert_key
|
|
102
|
+
KTNET_CORP_NUM=1234567890
|
|
103
|
+
KTNET_USER_ID=your_user_id
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## 발급 흐름
|
|
109
|
+
|
|
110
|
+
### 즉시 발급 (추천)
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
POST /api/v1/taxinvoice → 등록 + 발행 일괄 처리 → issued
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 단계별 발급
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
1. POST /api/v1/taxinvoice/register → draft (임시 저장)
|
|
120
|
+
2. POST /api/v1/taxinvoice/:seq/issue → issued (발행 처리)
|
|
121
|
+
3. (선택) GET /api/v1/taxinvoice/:seq/state → NTS 전송 상태 확인
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
## API 레퍼런스
|
|
127
|
+
|
|
128
|
+
이 문서는 기능 소개/설정/운영 기준을 다룹니다.
|
|
129
|
+
라우트별 파라미터 표, 요청/응답 예제, 상태코드는 아래 라우트 문서를 기준으로 확인합니다.
|
|
130
|
+
|
|
131
|
+
- 상세 API 레퍼런스: [Tax Invoice Routes](../routes/tax-invoice-routes.md)
|
|
132
|
+
|
|
133
|
+
기본 경로: `/api/v1/taxinvoice`
|
|
134
|
+
|
|
135
|
+
| 메서드 | 경로 | 설명 |
|
|
136
|
+
| ------ | -------------- | -------------------------- |
|
|
137
|
+
| `POST` | `/` | 즉시 발급 (등록+발행 일괄) |
|
|
138
|
+
| `POST` | `/register` | 세금계산서 등록 (draft) |
|
|
139
|
+
| `POST` | `/:seq/issue` | 발행 처리 |
|
|
140
|
+
| `POST` | `/:seq/cancel` | 발행 취소 |
|
|
141
|
+
| `GET` | `/:seq/state` | 처리 상태 조회 |
|
|
142
|
+
| `GET` | `/:seq` | 세금계산서 상세 조회 |
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## 상태 흐름
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
draft
|
|
150
|
+
│
|
|
151
|
+
├─ 발행 실패 → pre_issue_waiting (재시도 대기)
|
|
152
|
+
│
|
|
153
|
+
└─ 발행 성공 → issued
|
|
154
|
+
│
|
|
155
|
+
└─ 국세청 전송 대기 → accepted
|
|
156
|
+
│
|
|
157
|
+
└─ 전송 완료 (nts_state: completed)
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
| status | 설명 |
|
|
161
|
+
| ------------------- | ------------------- |
|
|
162
|
+
| `draft` | 임시 저장 |
|
|
163
|
+
| `pre_issue_waiting` | 발행 재시도 대기 중 |
|
|
164
|
+
| `issued` | 발행 완료 |
|
|
165
|
+
| `cancelled` | 취소됨 |
|
|
166
|
+
|
|
167
|
+
| nts_state | 설명 |
|
|
168
|
+
| ----------- | -------------------- |
|
|
169
|
+
| `pending` | 국세청 전송 전 |
|
|
170
|
+
| `accepted` | 국세청 수신 완료 |
|
|
171
|
+
| `completed` | 국세청 처리 완료 |
|
|
172
|
+
| `rejected` | 국세청에서 오류 반려 |
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## 국세청 전송
|
|
177
|
+
|
|
178
|
+
- 발행된 세금계산서는 **익일 오전까지** 국세청에 자동 전송됩니다.
|
|
179
|
+
- `nts_state: rejected` 시 사유를 확인 후 수정 재발행 필요합니다.
|
|
180
|
+
- 재전송은 프로바이더 어드민 또는 `/state` 폴링으로 확인 가능합니다.
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## 운영 팁
|
|
185
|
+
|
|
186
|
+
- 발행 전 `register`로 초안 저장 후 담당자 검토 → `issue` 권장 (오류 방지)
|
|
187
|
+
- `supply_value + tax_value = total_value` 를 반드시 확인 (검증 오류 가장 많음)
|
|
188
|
+
- 테스트 환경에서는 각 프로바이더의 샌드박스 API URL 사용
|
|
189
|
+
- 발행 취소는 국세청 전송 전에만 가능 → 이후에는 수정세금계산서 발행 필요
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## 관련 문서
|
|
194
|
+
|
|
195
|
+
- [Tax Invoice Routes](../routes/tax-invoice-routes.md)
|
|
196
|
+
- [설정 예제](../../src/app/plugins/taxinvoice/config.example.json)
|
|
197
|
+
- [Entity Server 세금계산서 가이드](../../../docs/plugins/tax-invoice-guide.md)
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
# 앱서버 담당 엔드포인트 전체 목록
|
|
2
|
+
|
|
3
|
+
> **라우트 우선순위**: `plugins/*/routes.ts` 및 `routes/*/route.ts`에 등록된 경로는
|
|
4
|
+
> Go 서버 패스스루보다 **항상 먼저 처리**됩니다.
|
|
5
|
+
> Go 서버가 제공하는 API 경로와 동일한 경로를 앱 서버에 정의하면 앱 서버가 우선 처리합니다.
|
|
6
|
+
> 자세한 내용: [라우트 추가 가이드 §6](how-to-create.md#6-go-서버-패스스루-오버라이드)
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 계정
|
|
11
|
+
|
|
12
|
+
> 상세: [account-routes.md](account-routes.md)
|
|
13
|
+
|
|
14
|
+
| 앱서버 경로 | 설명 |
|
|
15
|
+
| ------------------------------- | -------------------------------------------------- |
|
|
16
|
+
| `POST /api/v1/account/register` | 회원가입 + 이메일 인증 발송 |
|
|
17
|
+
| `POST /api/v1/account/withdraw` | 이메일 확보 → Go 익명화 내부 호출 → 완료 메일 발송 |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 2FA (TOTP)
|
|
22
|
+
|
|
23
|
+
> 상세: [account-routes.md](account-routes.md)
|
|
24
|
+
|
|
25
|
+
| 앱서버 경로 | 설명 |
|
|
26
|
+
| ---------------------------------------------- | -------------------- |
|
|
27
|
+
| `POST /api/v1/account/2fa/setup` | TOTP 설정 |
|
|
28
|
+
| `POST /api/v1/account/2fa/setup/verify` | TOTP 활성화 확인 |
|
|
29
|
+
| `DELETE /api/v1/account/2fa` | 2FA 비활성화 |
|
|
30
|
+
| `GET /api/v1/account/2fa/status` | 2FA 상태 조회 |
|
|
31
|
+
| `POST /api/v1/account/2fa/verify` | TOTP 검증 (2단계) |
|
|
32
|
+
| `POST /api/v1/account/2fa/recovery` | 리커버리 코드 로그인 |
|
|
33
|
+
| `POST /api/v1/account/2fa/recovery/regenerate` | 리커버리 코드 재생성 |
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## OAuth 소셜 로그인
|
|
38
|
+
|
|
39
|
+
> 상세: [account-routes.md](account-routes.md)
|
|
40
|
+
|
|
41
|
+
| 앱서버 경로 | 설명 |
|
|
42
|
+
| ------------------------------------------- | --------------------- |
|
|
43
|
+
| `GET /api/v1/oauth/:provider` | OAuth 리다이렉트 |
|
|
44
|
+
| `GET/POST /api/v1/oauth/:provider/callback` | OAuth 콜백 → JWT 발급 |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## OAuth 계정 연동
|
|
49
|
+
|
|
50
|
+
> 상세: [account-routes.md](account-routes.md)
|
|
51
|
+
|
|
52
|
+
| 앱서버 경로 | 설명 |
|
|
53
|
+
| ---------------------------------------------- | ---------------------- |
|
|
54
|
+
| `POST /api/v1/account/oauth/link` | OAuth 프로바이더 연동 |
|
|
55
|
+
| `DELETE /api/v1/account/oauth/link/:provider` | OAuth 연동 해제 |
|
|
56
|
+
| `GET /api/v1/account/oauth/providers` | 연동된 프로바이더 목록 |
|
|
57
|
+
| `POST /api/v1/account/oauth/refresh/:provider` | OAuth 토큰 갱신 |
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 이메일 인증
|
|
62
|
+
|
|
63
|
+
> 상세: [email-verification.md](email-verification.md)
|
|
64
|
+
|
|
65
|
+
| 앱서버 경로 | 설명 |
|
|
66
|
+
| ----------------------------------- | ------------------- |
|
|
67
|
+
| `POST /api/v1/email-verify/send` | 인증 코드/링크 발송 |
|
|
68
|
+
| `POST /api/v1/email-verify/confirm` | 인증 코드 확인 |
|
|
69
|
+
| `GET /api/v1/email-verify/activate` | 링크 클릭 인증 |
|
|
70
|
+
| `GET /api/v1/email-verify/status` | 인증 상태 조회 |
|
|
71
|
+
| `POST /api/v1/email-verify/change` | 이메일 변경 |
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## 비밀번호 재설정
|
|
76
|
+
|
|
77
|
+
> 상세: [password-reset.md](password-reset.md)
|
|
78
|
+
|
|
79
|
+
| 앱서버 경로 | 설명 |
|
|
80
|
+
| ------------------------------------- | ---------------- |
|
|
81
|
+
| `POST /api/v1/password-reset/request` | 재설정 메일 발송 |
|
|
82
|
+
| `GET /api/v1/password-reset/validate` | 토큰 유효성 확인 |
|
|
83
|
+
| `POST /api/v1/password-reset/verify` | 새 비밀번호 설정 |
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Push 알림
|
|
88
|
+
|
|
89
|
+
> 상세: [push-routes.md](push-routes.md) · 설정/운영: [../plugins/push.md](../plugins/push.md)
|
|
90
|
+
|
|
91
|
+
| 앱서버 경로 | 설명 |
|
|
92
|
+
| --------------------------------- | ----------------------------- |
|
|
93
|
+
| `POST /api/v1/push/device` | 디바이스 토큰 등록/갱신 |
|
|
94
|
+
| `DELETE /api/v1/push/device/:seq` | 디바이스 푸시 수신 비활성화 |
|
|
95
|
+
| `POST /api/v1/push/send` | Push 발송 (단일 계정) |
|
|
96
|
+
| `POST /api/v1/push/broadcast` | Push 브로드캐스트 (다중 계정) |
|
|
97
|
+
| `GET /api/v1/push/status/:seq` | 발송 상태 조회 안내 |
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## SMS
|
|
102
|
+
|
|
103
|
+
> 상세: [sms-routes.md](sms-routes.md) · 설정/운영: [../plugins/sms.md](../plugins/sms.md)
|
|
104
|
+
|
|
105
|
+
| Method | 앱서버 경로 | 설명 |
|
|
106
|
+
| ------ | --------------------------------- | -------------- |
|
|
107
|
+
| POST | `/api/v1/sms/send` | SMS 발송 |
|
|
108
|
+
| GET | `/api/v1/sms/status/:seq` | 발송 상태 조회 |
|
|
109
|
+
| POST | `/api/v1/sms/verification/send` | 인증번호 발송 |
|
|
110
|
+
| POST | `/api/v1/sms/verification/verify` | 인증번호 검증 |
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## SMTP 메일
|
|
115
|
+
|
|
116
|
+
> 상세: [smtp-routes.md](smtp-routes.md) · 설정/운영: [../plugins/smtp.md](../plugins/smtp.md)
|
|
117
|
+
|
|
118
|
+
| Method | 앱서버 경로 | 설명 |
|
|
119
|
+
| ------ | -------------------------- | ------------------------------- |
|
|
120
|
+
| POST | `/api/v1/smtp/send` | 로컬 템플릿 렌더링 후 메일 발송 |
|
|
121
|
+
| GET | `/api/v1/smtp/status/:seq` | 발송 상태 조회 |
|
|
122
|
+
|
|
123
|
+
> 위 경로 외의 `/api/v1/smtp/*` 는 Go 서버로 패스스루됩니다.
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## 알림톡 (Alimtalk)
|
|
128
|
+
|
|
129
|
+
> 상세: [alimtalk-routes.md](alimtalk-routes.md) · 설정/운영: [../plugins/alimtalk.md](../plugins/alimtalk.md)
|
|
130
|
+
|
|
131
|
+
| Method | 앱서버 경로 | 설명 |
|
|
132
|
+
| ------ | ------------------------------------ | ---------------- |
|
|
133
|
+
| POST | `/api/v1/alimtalk/send` | 알림톡 발송 |
|
|
134
|
+
| GET | `/api/v1/alimtalk/status/:seq` | 발송 상태 조회 |
|
|
135
|
+
| GET | `/api/v1/alimtalk/templates` | 템플릿 목록 조회 |
|
|
136
|
+
| POST | `/api/v1/alimtalk/webhook/:provider` | 공급사 웹훅 수신 |
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## 친구톡 (Friendtalk)
|
|
141
|
+
|
|
142
|
+
> 상세: [friendtalk-routes.md](friendtalk-routes.md) · 설정/운영: [../plugins/friendtalk.md](../plugins/friendtalk.md)
|
|
143
|
+
|
|
144
|
+
| Method | 앱서버 경로 | 설명 |
|
|
145
|
+
| ------ | ------------------------- | ----------- |
|
|
146
|
+
| POST | `/api/v1/friendtalk/send` | 친구톡 발송 |
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## PG 결제
|
|
151
|
+
|
|
152
|
+
> 상세: [pg-routes.md](pg-routes.md) · 설정/운영: [../plugins/pg.md](../plugins/pg.md)
|
|
153
|
+
|
|
154
|
+
| Method | 앱서버 경로 | 설명 |
|
|
155
|
+
| ------ | ----------------------------------- | ------------------------- |
|
|
156
|
+
| POST | `/api/v1/pg/orders` | 주문 생성 |
|
|
157
|
+
| GET | `/api/v1/pg/orders/:orderId` | 주문 단건 조회 |
|
|
158
|
+
| POST | `/api/v1/pg/confirm` | 결제 승인 |
|
|
159
|
+
| POST | `/api/v1/pg/orders/:orderId/cancel` | 결제 취소 |
|
|
160
|
+
| POST | `/api/v1/pg/orders/:orderId/sync` | 결제 상태 동기화 |
|
|
161
|
+
| POST | `/api/v1/pg/webhook` | PG 웹훅 수신 |
|
|
162
|
+
| GET | `/api/v1/pg/config` | 클라이언트 결제 설정 조회 |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## 세금계산서 (Tax Invoice)
|
|
167
|
+
|
|
168
|
+
> 상세: [tax-invoice-routes.md](tax-invoice-routes.md) · 설정/운영: [../plugins/taxinvoice.md](../plugins/taxinvoice.md)
|
|
169
|
+
|
|
170
|
+
| Method | 앱서버 경로 | 설명 |
|
|
171
|
+
| ------ | -------------------------------- | --------------------------------- |
|
|
172
|
+
| POST | `/api/v1/taxinvoice` | 세금계산서 등록/발행 요청(레거시) |
|
|
173
|
+
| POST | `/api/v1/taxinvoice/register` | 세금계산서 등록 |
|
|
174
|
+
| POST | `/api/v1/taxinvoice/:seq/issue` | 등록 건 발행 |
|
|
175
|
+
| POST | `/api/v1/taxinvoice/:seq/cancel` | 발행 취소 |
|
|
176
|
+
| GET | `/api/v1/taxinvoice/:seq/state` | 발행 상태 조회 |
|
|
177
|
+
| GET | `/api/v1/taxinvoice/:seq` | 상세 조회 |
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## LLM
|
|
182
|
+
|
|
183
|
+
> 상세: [llm-routes.md](llm-routes.md) · 설정/운영: [../plugins/llm.md](../plugins/llm.md)
|
|
184
|
+
|
|
185
|
+
| Method | 앱서버 경로 | 설명 |
|
|
186
|
+
| ------ | ----------------------------------------- | ------------------------------- |
|
|
187
|
+
| POST | `/api/v1/llm/chat` | 일반 채팅 응답 생성 |
|
|
188
|
+
| POST | `/api/v1/llm/chat/stream` | 스트리밍 채팅 응답 |
|
|
189
|
+
| POST | `/api/v1/llm/conversations` | 대화 세션 생성 |
|
|
190
|
+
| POST | `/api/v1/llm/conversations/:seq/messages` | 대화 메시지 전송 |
|
|
191
|
+
| GET | `/api/v1/llm/conversations` | 대화 세션 목록 |
|
|
192
|
+
| GET | `/api/v1/llm/conversations/:seq` | 대화 세션 상세 |
|
|
193
|
+
| PATCH | `/api/v1/llm/conversations/:seq` | 대화 세션 정보 수정 |
|
|
194
|
+
| DELETE | `/api/v1/llm/conversations/:seq` | 대화 세션 삭제 |
|
|
195
|
+
| POST | `/api/v1/llm/rag/documents` | RAG 문서 업로드 |
|
|
196
|
+
| GET | `/api/v1/llm/rag/documents` | RAG 문서 목록 |
|
|
197
|
+
| DELETE | `/api/v1/llm/rag/documents/:id` | RAG 문서 삭제 |
|
|
198
|
+
| POST | `/api/v1/llm/rag/search` | RAG 검색 |
|
|
199
|
+
| POST | `/api/v1/llm/rag/chat` | RAG 기반 채팅 |
|
|
200
|
+
| POST | `/api/v1/llm/rag/chat/stream` | RAG 스트리밍 채팅 |
|
|
201
|
+
| POST | `/api/v1/llm/rag/rebuild-index` | RAG 인덱스 재구성 |
|
|
202
|
+
| GET | `/api/v1/llm/providers` | 사용 가능한 LLM 프로바이더 조회 |
|
|
203
|
+
| GET | `/api/v1/llm/usage` | LLM 사용량 상세 |
|
|
204
|
+
| GET | `/api/v1/llm/usage/summary` | LLM 사용량 요약 |
|
|
205
|
+
| GET | `/api/v1/llm/cache/stats` | 캐시 통계 조회 |
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## OCR
|
|
210
|
+
|
|
211
|
+
> 상세: [ocr-routes.md](ocr-routes.md) · 설정/운영: [../plugins/ocr.md](../plugins/ocr.md)
|
|
212
|
+
|
|
213
|
+
| Method | 앱서버 경로 | 설명 |
|
|
214
|
+
| ------ | ------------------------------ | -------------------- |
|
|
215
|
+
| POST | `/api/v1/ocr/recognize` | OCR 동기 인식 |
|
|
216
|
+
| POST | `/api/v1/ocr/recognize/async` | OCR 비동기 인식 |
|
|
217
|
+
| POST | `/api/v1/ocr/:docType` | 문서 유형별 OCR 인식 |
|
|
218
|
+
| GET | `/api/v1/ocr/results` | OCR 결과 목록 조회 |
|
|
219
|
+
| GET | `/api/v1/ocr/results/:id` | OCR 결과 단건 조회 |
|
|
220
|
+
| GET | `/api/v1/ocr/results/:id/text` | OCR 텍스트 추출 조회 |
|
|
221
|
+
| DELETE | `/api/v1/ocr/results/:id` | OCR 결과 삭제 |
|
|
222
|
+
| GET | `/api/v1/ocr/quota` | OCR 사용량/쿼터 조회 |
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## 본인인증 (Identity)
|
|
227
|
+
|
|
228
|
+
> 상세: [identity-routes.md](identity-routes.md) · 설정/운영: [../plugins/identity.md](../plugins/identity.md)
|
|
229
|
+
|
|
230
|
+
| Method | 앱서버 경로 | 설명 |
|
|
231
|
+
| ------ | ------------------------------------- | ---------------- |
|
|
232
|
+
| POST | `/api/v1/identity/request` | 인증 요청 생성 |
|
|
233
|
+
| POST | `/api/v1/identity/callback` | 중계사 콜백 수신 |
|
|
234
|
+
| GET | `/api/v1/identity/result/:request_id` | 인증 결과 조회 |
|
|
235
|
+
| POST | `/api/v1/identity/verify-ci` | CI 중복 확인 |
|
|
236
|
+
|
|
237
|
+
---
|
|
238
|
+
|
|
239
|
+
## 공휴일 (Holidays)
|
|
240
|
+
|
|
241
|
+
> 상세: [holidays-routes.md](holidays-routes.md) · 설정/운영: [../plugins/holidays.md](../plugins/holidays.md)
|
|
242
|
+
|
|
243
|
+
| Method | 앱서버 경로 | 설명 |
|
|
244
|
+
| ------ | --------------------------- | --------------------------- |
|
|
245
|
+
| GET | `/api/v1/holidays` | 공휴일 목록 조회 |
|
|
246
|
+
| GET | `/api/v1/holidays/:locdate` | 특정 날짜 공휴일 단건 조회 |
|
|
247
|
+
| POST | `/api/v1/holidays/sync` | 수동 동기화 트리거 (관리자) |
|