README.md

PHCDevworks RubyApiPackCloudways

Overview

RubyApiPackActiveCampaign is a Ruby gem designed to simplify interaction with the ActiveCampaign API. This gem offers an easy-to-use interface for managing contacts, lists, and automations within ActiveCampaign, enabling seamless integration of marketing automation functionality into your Ruby applications. With a modular and extensible design, it allows developers to work with ActiveCampaign resources without handling raw HTTP requests or worrying about low-level API details.

Key Features:

• Contact Management: Easily fetch, create, and update contacts within ActiveCampaign.
• Contact Lists: Retrieve lists of contacts or specific contact details using intuitive methods.
• Resource Fetching: Use high-level methods to access ActiveCampaign resources with minimal setup.
• Seamless API Interaction:: Abstracts complex HTTP requests into simple, reusable Ruby methods.
• Secure API Configuration: Manage API tokens and URLs securely through environment variables or configuration blocks.
• Extensible Design: Built to support additional ActiveCampaign API resources, making it easy to extend functionality as needed.
• Error Handling: Gracefully handle API errors with descriptive messages, ensuring smooth API interactions.
• RSpec-Ready: Includes test support and easy-to-mock API responses, facilitating efficient development and testing.

This gem is perfect for Ruby developers looking to integrate ActiveCampaign into their applications, providing essential marketing automation tools with minimal effort.

Usage

1. Set up Active Campaign API credentials

You will need to configure your Active Campaign API credentials in your Ruby environment. Here’s how you can do it:

1. Open your configuration block in the initializer or main application file:

RubyApiPackActiveCampaign.configure do |config|
  config.ac_api_url = '<YOUR_ACTIVECAMPAIGN_API_URL>'
  config.ac_api_token = '<YOUR_ACTIVECAMPAIGN_API_KEY>'
end

2. Save and restart your application.

Installation

Add this line to your application's Gemfile:

gem "ruby_api_pack_active_campaign"

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruby_api_pack_active_campaign

Contributing

License

The gem is available as open source under the terms of the MIT License.