홈페이지>프로그래밍 관련>기타 소스코드
다운로드

MailerLite Ruby SDK

시작하기

MailerLite API에 대한 자세한 내용을 보려면 다음 링크를 방문하십시오.

입증

API 키는 초기 설정 이후에 사람이 직접 입력하지 않고도 기계 간 인증을 구현하는 빠른 방법입니다.

API 키를 얻는 방법에 대한 자세한 내용을 보려면 다음 링크를 방문하세요.

목차

  • MailerLite Ruby SDK
    • 시작하기
      • 입증
    • 목차
    • 설치
    • 용법
      • 메일러라이트 클라이언트
    • 구독자
      • 모든 가입자 나열
      • 구독자 만들기
      • 구독자 업데이트
      • 구독자 확보
      • 구독자 삭제
    • 여러 떼
      • 모든 그룹 나열
      • 그룹 만들기
      • 그룹 업데이트
      • 그룹 삭제
      • 그룹에 속한 구독자 확보
      • 구독자를 그룹에 할당
      • 그룹에서 구독자 할당 취소
    • 세그먼트
      • 모든 세그먼트 나열
      • 세그먼트 업데이트
      • 세그먼트 삭제
      • 세그먼트에 속한 구독자 가져오기
    • 전지
      • 모든 필드 나열
      • 필드 만들기
      • 필드 업데이트
      • 필드 삭제
    • 자동화
      • 모든 자동화 나열
      • 자동화 받기
      • 자동화에 대한 구독자 활동 가져오기
    • 캠페인
      • 모든 캠페인 나열
      • 캠페인 받기
      • 캠페인 만들기
      • 캠페인 업데이트
      • 캠페인 예약
      • 캠페인 취소
      • 캠페인 삭제
      • 캠페인에 대한 구독자 활동 가져오기
    • 양식
      • 모든 양식 나열
      • 양식 받기
      • 양식 업데이트
      • 양식 삭제
      • 특정 양식에 가입한 구독자를 확보하세요.
    • 일괄 처리
      • 새 배치 만들기
    • 웹훅
      • 모든 웹훅 나열
      • 웹훅 받기
      • 웹훅 만들기
      • 웹훅 업데이트
      • 웹훅 삭제
    • 시간대
      • 시간대 목록 가져오기
    • 캠페인 언어
      • 언어 목록 가져오기

설정 

gem install mailerlite-ruby

require "mailerlite-ruby" 사용하여 Ruby 파일에서 이를 초기화해야 합니다.

용법

이 SDK를 사용하려면 MAILERLITE_API_TOKEN 환경 변수가 포함된 .env 파일이 있거나 변수가 시스템 전체에서 활성화되어 있어야 합니다(Docker/Kubernetes에 유용함). MAILERLITE_API_TOKEN 의 모양에 대한 예는 .env.example 에 있습니다.

구독자

모든 가입자 나열 

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . fetch ( filter : { status : 'active' } )

구독자 만들기 

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . create ( email : '[email protected]' , fields : { 'name' : 'John' , 'last_name' : 'Doe' } , ip_address : '1.2.3.4' , optin_ip : '1.2.3.4' )

구독자 업데이트 

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . update ( email : '[email protected]' , fields : { 'name' : 'John' , 'last_name' : 'Doe' } , ip_address : '1.2.3.4' , optin_ip : '1.2.3.4' )

구독자 확보 

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscribers . get ( '[email protected]' )

구독자 삭제 

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

subscriber_id = 1234567890

subscribers . delete ( subscriber_id )

여러 떼

모든 그룹 나열 

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . list ( limit : 10 , page : 1 , filter : { 'name' : 'My' } , sort : 'name' )

그룹 만들기 

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . create ( name : 'Group Name' )

그룹 업데이트 

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . update ( group_id : 1234567 , name : 'My New Group' )

그룹 삭제 

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

group_id = 1234567

groups . delete ( group_id )

그룹에 속한 구독자 확보 

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . get_subscribers ( group_id : 1234567 , page : 1 , limit : 10 , filter : { 'status' : 'active' } )

구독자를 그룹에 할당 

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . assign_subscriber ( subscriber : 111222 , group_id : 1234567 )

그룹에서 구독자 할당 취소 

 require "mailerlite-ruby"

# Intialize the class
groups = MailerLite :: Groups . new

groups . unassign_subscriber ( subscriber : 111222 , group_id : 1234567 )

세그먼트

모든 세그먼트 나열 

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new

segments . list ( limit : 10 , page : 1 )

세그먼트 업데이트 

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new

segments . update ( segment_id : 123456 , name : 'My New Segment Name' )

세그먼트 삭제 

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new
segment_id = 123456

segments . delete ( segment_id )

세그먼트에 속한 구독자 가져오기 

 require "mailerlite-ruby"

# Intialize the class
segments = MailerLite :: Segments . new

segments . get_subscribers ( segment_id : 123456 , limit : 10 , filter : { 'status' : 'active' } )

전지

모든 필드 나열 

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

fields . get ( limit : 10 , page : 1 , sort : 'name' , filter : { 'keyword' : 'abc' , 'type' : 'text' } )

필드 만들기 

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

fields . create ( name : 'My Field' , type : 'text' )

필드 업데이트 

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

fields . update ( field_id : 123345 , name : 'My New Field' )

필드 삭제 

 require "mailerlite-ruby"

# Intialize the class
fields = MailerLite :: Fields . new

field_id = 123456

fields . delete ( field_id )

자동화

모든 자동화 나열 

 require "mailerlite-ruby"

# Intialize the class
automations = MailerLite :: Automations . new

automations . get ( limit : 10 , page : 1 , filter : { 'status' : true , 'name' : 'some name' , 'group' : 123456 } )

자동화 받기 

 require "mailerlite-ruby"

# Intialize the class
automations = MailerLite :: Automations . new

automation_id = 123456

automations . fetch ( automation_id )

자동화에 대한 구독자 활동 가져오기 

 require "mailerlite-ruby"

# Intialize the class
automations = MailerLite :: Automations . new

automations . get_subscriber_activity ( automation_id : 123456 , page : 1 , limit : 10 , filter : { 'status' : 'active' , 'date_from' : '2022-12-20' , 'date_to' : '2022-12-31' } )

캠페인

모든 캠페인 나열 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . get ( limit : 10 , page : 1 , filter : { 'status' : 'ready' , 'type' : 'regular' } )

캠페인 받기 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . fetch ( campaign_id : 123456 )

캠페인 만들기 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . create (
    name : "Test Campaign" ,
    language_id : 1 ,
    type : "regular" ,
    emails : [ {
        "subject" : "This is a test campaign" ,
        "from_name" : "Test Man" ,
        "from" : "[email protected]" ,
        "content" : "Hi there, this is a test campaign!"
    } ]
  )

캠페인 업데이트 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . update (
  campaign_id : 1233455 , 
  name : "New Campaign Name" ,
  language_id : 2 ,
  emails : [ {
      "subject" : "This is a test campaign" ,
      "from_name" : "Test Man" ,
      "from" : "[email protected]" ,
      "content" : "Hi there, this is a test campaign!"
  } ]
  )

캠페인 예약 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . schedule (
  campaign_id : 123456 ,
  delivery : "scheduled" ,
  schedule : {
      "date" : "2022-12-31" ,
      "hours" : "22" ,
      "minutes" : "00"
  }
)

캠페인 취소 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaign_id = 123456

campaigns . cancel ( campaign_id )

캠페인 삭제 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaign_id = 123456

campaigns . delete ( campaign_id )

캠페인에 대한 구독자 활동 가져오기 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaign_id = 123456

campaigns . activity ( campaign_id )

양식

모든 양식 나열 

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

forms . list ( limit : 10 , page : 1 , sort : 'name' , filter : { 'name' : 'form name' } )

양식 받기 

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

form_id = 123456

forms . fetch ( form_id )

양식 업데이트 

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

forms . update ( form_id : 123456 , name : 'My form Name' )

양식 삭제 

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

form_id = 123456

forms . delete ( form_id )

특정 양식에 가입한 구독자를 확보하세요. 

 require "mailerlite-ruby"

# Intialize the class
forms = MailerLite :: Forms . new

forms . fetch_subscribers ( form_id : 123345 , page : 1 , limit : 10 , filter : { 'status' : 'active' } )

일괄 처리

새 배치 만들기 

 require "mailerlite-ruby"

# Intialize the class
batch = MailerLite :: Batch . new

batch . request (
          requests : [
            { method : 'GET' , path : 'api/subscribers/list' } ,
            { method : 'GET' , path : 'api/campaigns/list' }
          ]
        )

웹훅

모든 웹훅 나열 

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

webhooks . list ( )

웹훅 받기 

 require "mailerlite-ruby"

# Intialize the class
subscribers = MailerLite :: Subscribers . new

webhook_id = 123456

webhooks . get ( webhook_id )

웹훅 만들기 

 require "mailerlite-ruby"

# Intialize the class
webhooks = MailerLite :: Webhooks . new

webhooks . create (
  events : [
    'subscriber.created' ,
    'subscriber.updated' ,
    'subscriber.unsubscribed'
  ] , 
  url : 'https://my-url.com' ,
  name : 'Webhook name'
)

웹훅 업데이트 

 require "mailerlite-ruby"

# Intialize the class
webhooks = MailerLite :: Webhooks . new

webhooks . update (
  webhook_id : 123456 , 
  events : [
    'subscriber.created' ,
    'subscriber.updated' ,
    'subscriber.unsubscribed'
  ] , 
  url : 'https://my-url.com' ,
  name : 'Webhook name' ,
  enabled : false
)

웹훅 삭제 

 require "mailerlite-ruby"

# Intialize the class
webhooks = MailerLite :: Webhooks . new

webhook_id = 123456

webhooks . delete ( webhook_id )

시간대

시간대 목록 가져오기 

 require "mailerlite-ruby"

# Intialize the class
timezones = MailerLite :: Timezones . new

timezones . list ( )

캠페인 언어

언어 목록 가져오기 

 require "mailerlite-ruby"

# Intialize the class
campaigns = MailerLite :: Campaigns . new

campaigns . languages ( )

테스트 

bundle i 
bundle exec rspec spec/ * rspec.rb

테스트를 실행하려면 번들을 사용하여 gem을 설치한 다음 번들을 통해 rspec을 실행하여 모든 테스트를 실행해야 합니다. 테스트를 위한 픽스처는 vcr을 사용하여 기록되었으며 ./fixtures 디렉토리에서 사용할 수 있습니다.

문서 생성 

bundle i 
bundle exec yardoc ' lib/**/*.rb '

그러면 모든 브라우저에서 열 수 있는 doc 디렉토리에 html 문서가 생성됩니다. index.html로 이동하여 엽니다.

확장하다
추가 정보
관련 애플리케이션
추천
관련 정보 전체