Magic Admin Ruby SDK

The Magic Admin Ruby SDK provides convenient ways for developers to interact with Magic API endpoints and an array of utilities to handle DID Token.

Table of Contents

• Documentation
• Quick Start
• Changelog
• License

Documentation

See the Magic doc!

Installation

Add this line to your application's Gemfile:

gem 'magic-admin'

And then execute:

$ bundle

Or install it yourself as:

$ gem install magic-admin

Prerequisites

• Ruby 2.5+

Quick Start

Before you start, you will need an API secret key. You can get one from the Magic Dashboard. Once you have the API secret key, you can instantiate a Magic object.

require 'magic-admin'

magic = Magic.new(api_secret_key: '<YOUR_API_SECRET_KEY>')

magic.token.validate('DID_TOKEN')

# Read the docs to learn more! 🚀

Optionally if you would like, you can load the API secret key from the environment variable, MAGIC_API_SECRET_KEY.

# Set the env variable `MAGIC_API_SECRET_KEY`.

magic = Magic.new

Note: The arguments passed to the Magic object takes precedence over the environment variables.

Configure Network Strategy

The Magic object also takes in retries, timeout and backoff as optional arguments at the object instantiation time so you can override those values for your application setup.

magic = Magic.new(retries: 5, timeout: 10, backoff: 0.03)

Changelog

See Changelog

License

See License