Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.rst

https://raw.github.com/TeleSign/ruby_telesign/master/ruby_banner_enterprise.jpg

TeleSign Enterprise Ruby SDK

TeleSign is a communications platform as a service (CPaaS) company, founded on security. Since 2005, TeleSign has been a trusted partner to the world’s leading websites and mobile applications, helping secure billions of end-user accounts. Today, TeleSign’s data-driven, cloud communications platform is changing the way businesses engage with customers and prevent fraud.

For more information about TeleSign, visit our website.

Documentation

Code documentation is included in the SDK. Complete documentation, quick start guides and reference material for the TeleSign API is available within the TeleSign Enterprise Documentation.

Installation

To install the TeleSign Enterprise Ruby SDK:

$ gem build /path/to/telesignenterprise.gemspec
$ gem install /path/to/telesignenterprise-(insert latest version).gem

Ruby 2+ is required for the TeleSign Enterprise Ruby SDK.

Authentication

You will need a Customer ID and API Key in order to use TeleSign’s REST API. If you are already a customer and need an API Key, you can retrieve it from TelePortal.

Dependencies

We make use of popular, feature-rich and well-tested open-source libraries to perform the underlying functionality of the SDK. These dependencies are managed by the community accepted package manager. If you are unable to add these additional third party dependencies to your project we have ensured that the SDK code is easy to read and can serve as sample code. We have also made sure that more complicated functions such as generate_telesign_headers can be easily extracted from the SDK and used 'as is' in your project.

Ruby Code Example: Verify SMS

Here is a basic code example with JSON response.

require 'telesignenterprise'

customer_id = 'FFFFFFFF-EEEE-DDDD-1234-AB1234567890'
api_key = 'EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=='

phone_number = 'phone_number'

verify_client = TelesignEnterprise::VerifyClient.new(customer_id, api_key)
response = verify_client.sms(phone_number)
{'errors': [],
 'reference_id': '25685A40218006049044A58789044948',
 'resource_uri': '/v1/verify/25685A40218006049044A58789044948',
 'status': {'code': 290,
    'description': 'Message in progress',
    'updated_on': '2017-02-07T03:13:42.610863Z'},
 'sub_resource': 'sms',
 'verify': {'code_entered': '',
    'code_state': 'UNKNOWN'}}

For more examples, see the examples folder or visit the TeleSign Enterprise Documentation.

About

The TeleSign Ruby SDK lets you easily integrate with our REST API.

Resources

License

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages