sendgo-rails 1.2.1 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +132 -0
- data/lib/sendgo/rails/version.rb +1 -1
- data/lib/sendgo/rails.rb +8 -0
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: db269ad58d31692763ef2272064c76b0d48d96ab4def0b3423b14fee953f64d0
|
|
4
|
+
data.tar.gz: 2c6a3a6284b5312d717a4903ef4bb945187177d59967d339b119d7dae755ccbc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fa7a1c12c3465d1ad0013402b6f1e92eea7ae85cefc84ad5e07d8bc132ada65ae156770fe749cc248ce3a823cbd2eadc36dde2cc811d687527ea07afd41afb0f
|
|
7
|
+
data.tar.gz: 6c5415d26b8f007e5bbf45ee71c4c64c0e0f754cd71de1cd57ca38d02c7dade895118d038b37d9b82825edb5a0e88971d4465c77d9d6dc5610d08337995af40d
|
data/README.md
CHANGED
|
@@ -337,8 +337,118 @@ A. `Sendgo::Rails.reset!`을 호출하면 메모이즈된 클라이언트가 초
|
|
|
337
337
|
사용 예시와 파라미터는 [코어 README](https://github.com/send-go) 와
|
|
338
338
|
[SDK 가이드](https://sendgo.io/ko/sdk) 를 참고하세요.
|
|
339
339
|
|
|
340
|
+
## 관리 API — 채널·템플릿·발신번호 등록 (v2 전용)
|
|
341
|
+
|
|
342
|
+
`Sendgo::Rails.client` 에 코어의 관리 서비스가 그대로 붙어 있습니다.
|
|
343
|
+
콘솔에서만 되던 등록·심사를 컨트롤러나 rake 태스크에서 처리할 수 있습니다.
|
|
344
|
+
|
|
345
|
+
| 접근 | 하는 일 | 계정 |
|
|
346
|
+
| --- | --- | --- |
|
|
347
|
+
| `.kakao_senders` | 카카오 채널 인증·등록·동기화, 브랜드메시지 M/N 신청 | 기업 |
|
|
348
|
+
| `.notice_templates` | 알림톡 템플릿 CRUD, 검수 요청·취소, 승인 취소, 휴면 해제 | 기업 |
|
|
349
|
+
| `.brand_templates` | 브랜드메시지 템플릿 CRUD, 동기화, 가져오기 | 기업 |
|
|
350
|
+
| `.sender_registration` | 발신번호 등록 신청, 중복 확인, 유형 안내 | 개인·기업 |
|
|
351
|
+
| `.message_templates` | 문자 상용구 템플릿 CRUD | 개인·기업 |
|
|
352
|
+
| `.kakao_images` | 카카오 이미지 업로드 — 템플릿용 URL 발급 | 기업 |
|
|
353
|
+
| `.rejected_numbers` | 수신거부(080) 번호 조회 | 개인·기업 |
|
|
354
|
+
| `.webhook` | 이벤트 웹훅 구독 — 심사 결과 수신 | 개인·기업 |
|
|
355
|
+
|
|
356
|
+
> **sendgo.io 콘솔에 들어올 일이 없습니다.** 고객의 채널·발신번호·템플릿을
|
|
357
|
+
> 여러분 화면만으로 끝까지 처리할 수 있습니다. 휴대폰 발신번호는 콘솔의 PASS
|
|
358
|
+
> 본인인증 대신 **신분증 사본(`identityDocument`)을 받아 sendgo 운영자가 대신
|
|
359
|
+
> 심사**합니다.
|
|
360
|
+
>
|
|
361
|
+
> 사람이 개입하는 지점은 **카카오 채널 인증번호 하나**뿐이고, 그마저도
|
|
362
|
+
> 여러분 화면에서 입력받으면 됩니다 — 카카오가 관리자 휴대폰으로 직접 보내는
|
|
363
|
+
> 확인이라 없앨 수 없습니다.
|
|
364
|
+
>
|
|
365
|
+
> 심사가 붙는 것들은 **비동기**입니다. 등록 호출이 성공했다는 건 "접수됐다"는
|
|
366
|
+
> 뜻이지 "쓸 수 있다"는 뜻이 아닙니다 — 웹훅을 구독해 결과를 받으세요.
|
|
367
|
+
|
|
368
|
+
```ruby
|
|
369
|
+
# app/controllers/onboarding_controller.rb
|
|
370
|
+
class OnboardingController < ApplicationController
|
|
371
|
+
# 1단계 — 카카오가 관리자 휴대폰으로 인증번호를 SMS 발송한다
|
|
372
|
+
def request_channel_code
|
|
373
|
+
Sendgo::Rails.client.kakao_senders.request_token(params[:yellow_id], params[:phone])
|
|
374
|
+
render json: { message: "인증번호를 발송했습니다." }
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
# 2단계 — 사용자가 입력한 인증번호로 발신프로필 생성
|
|
378
|
+
def create_channel
|
|
379
|
+
created = Sendgo::Rails.client.kakao_senders.create(
|
|
380
|
+
token: params[:code],
|
|
381
|
+
yellow_id: params[:yellow_id],
|
|
382
|
+
phone_number: params[:phone],
|
|
383
|
+
category_code: "001001"
|
|
384
|
+
)
|
|
385
|
+
|
|
386
|
+
render json: created.dig("data", "sender")
|
|
387
|
+
end
|
|
388
|
+
end
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
```ruby
|
|
392
|
+
# lib/tasks/sendgo.rake
|
|
393
|
+
namespace :sendgo do
|
|
394
|
+
desc "표준 알림톡 템플릿을 등록하고 검수를 요청한다"
|
|
395
|
+
task :provision_templates, [:kakao_sender_key] => :environment do |_t, args|
|
|
396
|
+
created = Sendgo::Rails.client.notice_templates.create(
|
|
397
|
+
kakao_sender_key: args[:kakao_sender_key],
|
|
398
|
+
template_name: "주문 접수 안내",
|
|
399
|
+
template_content: "\#{name}님, 주문 \#{orderNo}이 접수되었습니다.",
|
|
400
|
+
template_message_type: "BA",
|
|
401
|
+
template_emphasize_type: "NONE",
|
|
402
|
+
category_code: "001001",
|
|
403
|
+
message_purpose: "order_delivery",
|
|
404
|
+
legal_basis: "transaction",
|
|
405
|
+
benefit_origin: "none",
|
|
406
|
+
expiry_type: "none"
|
|
407
|
+
)
|
|
408
|
+
|
|
409
|
+
code = created.dig("data", "template", "templateCode")
|
|
410
|
+
Sendgo::Rails.client.notice_templates.request_inspection(code)
|
|
411
|
+
|
|
412
|
+
puts "검수 요청 완료: #{code}"
|
|
413
|
+
end
|
|
414
|
+
|
|
415
|
+
desc "검수 결과를 확인한다 — 30분마다 돌린다"
|
|
416
|
+
task poll_inspections: :environment do
|
|
417
|
+
PendingTemplate.where(approved_at: nil).find_each do |pending|
|
|
418
|
+
result = Sendgo::Rails.client.notice_templates.sync(pending.template_code)
|
|
419
|
+
status = result.dig("data", "template", "inspectionStatus")
|
|
420
|
+
|
|
421
|
+
pending.update!(approved_at: Time.current) if status == "APR"
|
|
422
|
+
pending.update!(rejected_reason: result.dig("data", "template", "comments")) if status == "REJ"
|
|
423
|
+
end
|
|
424
|
+
end
|
|
425
|
+
end
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
검수는 30분~1영업일 걸립니다. 배포 파이프라인 안에서 동기적으로 기다리지 말고
|
|
429
|
+
`solid_queue` 나 cron 으로 폴링하세요.
|
|
430
|
+
|
|
431
|
+
전체 파라미터는 [sendgo gem README](https://github.com/send-go/ruby) 를 참고하세요.
|
|
432
|
+
|
|
433
|
+
---
|
|
434
|
+
|
|
340
435
|
## 변경 사항
|
|
341
436
|
|
|
437
|
+
### 1.3.0 (2026-09-11)
|
|
438
|
+
|
|
439
|
+
- **관리 API 노출** — 코어 1.3.0 의 `kakao_senders` · `notice_templates` ·
|
|
440
|
+
`brand_templates` · `sender_registration` · `message_templates` 를
|
|
441
|
+
`Sendgo::Rails.client` 에서 그대로 쓸 수 있습니다. 콘솔에서만 되던 채널 등록,
|
|
442
|
+
알림톡 템플릿 검수 요청, 발신번호 심사 접수를 컨트롤러나 rake 태스크에서
|
|
443
|
+
처리합니다.
|
|
444
|
+
- `sendgo` 젬 의존성을 `~> 1.3` 으로 올렸습니다.
|
|
445
|
+
- **이벤트 웹훅** 추가 — 발신번호 승인, 알림톡 검수 결과, 채널 차단,
|
|
446
|
+
브랜드메시지 타겟팅 결과를 구독해 받습니다. 서명은 받은 원본 바이트로
|
|
447
|
+
검증합니다(SDK 에 검증 헬퍼 포함).
|
|
448
|
+
- **카카오 이미지 업로드** 추가 — 브랜드메시지 템플릿의 `imageUrl` 은 카카오가
|
|
449
|
+
호스팅하는 URL 이어야 하는데, 그 URL 을 얻는 길이 콘솔에만 있었습니다.
|
|
450
|
+
- **수신거부(080) 조회** 추가 — 자기 DB 의 수신 상태를 맞출 수 있습니다.
|
|
451
|
+
|
|
342
452
|
### 1.2.1 (2026-08-14)
|
|
343
453
|
|
|
344
454
|
- 레지스트리 목록에 노출되는 패키지 설명에서 친구톡을 브랜드메시지로 교체했습니다.
|
|
@@ -366,3 +476,25 @@ MIT License © 2026 [Sendgo](https://sendgo.io)
|
|
|
366
476
|
---
|
|
367
477
|
|
|
368
478
|
*키워드: 카카오 알림톡 Rails, 카카오 친구톡 Rails, SMS 발송 Rails, 알림톡 Rails gem, Rails 카카오 API 연동, Rails Railtie, Sendgo Rails SDK*
|
|
479
|
+
|
|
480
|
+
## 계정 API (1.4.0)
|
|
481
|
+
|
|
482
|
+
코어 1.4.0의 계정·조직·API 키·허용 IP 관리 12개 API를 사용할 수 있습니다.
|
|
483
|
+
발송용 키 없이 에이전트 토큰만으로 구성할 수 있습니다.
|
|
484
|
+
|
|
485
|
+
발송용 `accessKey`/`secretKey`가 없는 단계에서 사용하는 **별도 계정 클라이언트**입니다.
|
|
486
|
+
콘솔에서 발급받은 에이전트 토큰(`SENDGO_AGENT_TOKEN`)으로 `/api/v2/account`를 호출합니다.
|
|
487
|
+
계정 조회에는 `account:read`, 키·허용 IP 변경에는 `keys:write` 권한이 필요합니다.
|
|
488
|
+
토큰 만료나 권한 부족(401/403)은 그대로 예외로 반환하며 자동 갱신·재시도하지 않습니다.
|
|
489
|
+
|
|
490
|
+
조직 선택은 서버에 저장되는 **사용자 계정의 현재 조직**을 바꿉니다. 같은 사용자로
|
|
491
|
+
여러 조직의 설정을 동시에 변경하지 마세요. 개인 계정으로 돌아가려면 조직 ID에
|
|
492
|
+
`null`(Python `None`, Ruby `nil`, Go `nil`) 또는 `personal`을 전달합니다.
|
|
493
|
+
키 발급 응답의 `data.apiKey.secretKey`는 한 번만 반환되므로 서버의 비밀 저장소에 보관하세요.
|
|
494
|
+
허용 IP가 하나라도 등록되면 목록 밖의 IP는 차단됩니다.
|
|
495
|
+
에이전트 토큰과 키는 브라우저·모바일 앱에 포함하거나 응답·로그에 출력하지 않습니다.
|
|
496
|
+
|
|
497
|
+
```ruby
|
|
498
|
+
# SENDGO_AGENT_TOKEN 또는 config.sendgo.agent_token을 설정합니다.
|
|
499
|
+
status = Sendgo::Rails.account_client.me
|
|
500
|
+
```
|
data/lib/sendgo/rails/version.rb
CHANGED
data/lib/sendgo/rails.rb
CHANGED
|
@@ -33,6 +33,14 @@ module Sendgo
|
|
|
33
33
|
@client ||= build_client
|
|
34
34
|
end
|
|
35
35
|
|
|
36
|
+
# 발송용 키 없이 계정 클라이언트를 만듭니다.
|
|
37
|
+
def account_client
|
|
38
|
+
Sendgo::AccountClient.new(
|
|
39
|
+
agent_token: config_value(:agent_token, "SENDGO_AGENT_TOKEN"),
|
|
40
|
+
base_url: config_value(:url, "SENDGO_URL") || "https://sendgo.io"
|
|
41
|
+
)
|
|
42
|
+
end
|
|
43
|
+
|
|
36
44
|
# 메모이즈된 클라이언트를 초기화한다. (주로 테스트에서 사용)
|
|
37
45
|
#
|
|
38
46
|
# @return [void]
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sendgo-rails
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Sendgo
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-09-22 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: sendgo
|
|
@@ -16,14 +16,14 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - "~>"
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: '1.
|
|
19
|
+
version: '1.4'
|
|
20
20
|
type: :runtime
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
24
|
- - "~>"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version: '1.
|
|
26
|
+
version: '1.4'
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: railties
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|