Skip to content

Commit

Permalink
Merge pull request #7 from erikkai/patch-1
Browse files Browse the repository at this point in the history 
Minor edits
  • Loading branch information
@hmorales
hmorales authored Jun 23, 2016
2 parents 81dfc7c + 11ca5c6 commit a8bda48
Showing 1 changed file with 18 additions and 21 deletions.
39 changes: 18 additions & 21 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@
TeleSign
========

:Info:
For more information, visit the `TeleSign web site <http://www.TeleSign.com>`_.
For the latest source code, visit the `TeleSign github repository <http://github.com/TeleSign/ruby_telesign/tree>`_.
**Information**: For more information, visit the `TeleSign website <http://www.TeleSign.com>`_ or the `TeleSign Developer Portal <https://developer.telesign.com/>`_.

:Author:
Telesign Corp.
**Author**: Telesign Corp.

---------------------------------
TeleSign Web Services: Ruby SDK
---------------------------------

**TeleSign Web Services** conform to the `REST Web Service Design Model <http://en.wikipedia.org/wiki/Representational_state_transfer>`_. Services are exposed as URI-addressable resources through the set of *RESTful* procedures in our **TeleSign REST API**.
**TeleSign web services** conform to the `REST Web Service Design Model <http://en.wikipedia.org/wiki/Representational_state_transfer>`_. Services are exposed as URI-addressable resources through the set of *RESTful* procedures in our **TeleSign REST API**.

The **TeleSign Ruby SDK** is a set of software development tools—a *Ruby Library* that wraps the TeleSign REST API, and it simplifies TeleSign application development in the `Ruby programming language <https://www.ruby-lang.org/>`_. The SDK software is packaged as a Ruby gem called **telesign**, and is distributed using `Ruby Gems <https://rubygems.org/>`_.

Expand All @@ -30,46 +26,47 @@ With just two classes, **Telesign::API** abstracts much of the complexity of the
| | |
| | *standard* |
| | Retrieves the standard set of details about the specified phone |
| | number. This includes the type of phone (e.g., land line or mobile), |
| | and it's approximate geographic location. |
| | number. This includes the type of phone (for example, land line or |
| | mobile), and its approximate geographic location. |
| | *score* |
| | Retrieves a score for the specified phone number. This ranks the |
| | phone number's "risk level" on a scale from 0 to 1000, so you can |
| | code your web application to handle particular use cases (e.g., to |
| | stop things like chargebacks, identity theft, fraud, and spam). |
| | code your web application to handle particular use cases (for |
| | example, to stop things like chargebacks, identity theft, fraud, and |
| | spam). |
| | *contact* |
| | In addition to the information retrieved by *standard*, this service |
| | provides the Name & Address associated with the specified phone |
| | provides the name and address associated with the specified phone |
| | number. |
| | *live* |
| | In addition to the information retrieved by standard, this service |
| | provides actionable data associated with the specified phone number. |
| | |
+------------------------+--------------------------------------------------------------------------+
| Telesign::API::Verify | The **Verify** class exposes four services for sending users a |
| Telesign::API::Verify | The **Verify** class exposes five services for sending users a |
| | verification token (a three to five-digit number). You can use this |
| | mechanism to simply test whether you can reach users at the phone number |
| | mechanism to test whether you can reach users at the phone number |
| | they supplied, or you can have them use the token to authenticate |
| | themselves with your web application. In addition, this class also |
| | exposes a service that allows you to confirm the result of the |
| | authentication. |
| | |
| | You can use this verification factor in combination with *username* |
| | & *password* to provide *two-factor* authentication for higher |
| | and *password* to provide *two-factor* authentication for higher |
| | security. |
| | |
| | *call* |
| | Calls the specified phone number, and using speech synthesis—speaks |
| | Calls the specified phone number and uses speech synthesis to speak |
| | the verification code to the user. |
| | *sms* |
| | Send a text message containing the verification code to the |
| | Sends a text message containing the verification code to the |
| | specified phone number (supported for mobile phones only). |
| | *smart* |
| | Smart will intelligently determines the best service to use based on |
| | Smart intelligently determines the best service to use based on |
| | the end user device and then attempts to place a call, send an SMS, |
| | or send a push request. |
| | *push* |
| | Send a push notification containing the verification code to the |
| | Sends a push notification containing the verification code to the |
| | specified phone number (supported for registered devices only). |
| | *status* |
| | Retrieves the verification result. You make this call in your web |
Expand All @@ -82,7 +79,7 @@ Installation
------------

With `Ruby Gems <https://github.com/rubygems/rubygems>`_
installed, simply type **gem install telesign** at the command prompt.
installed, type **gem install telesign** at the command prompt.

Ruby Code Example: To Verify a Call
-------------------------------------
Expand All @@ -106,7 +103,7 @@ For more examples, see the Documentation section below.
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 generate one in the `Client Portal <https://portal.telesign.com>`_. If you are not a customer and would like to get an API Key, please contact `support@telesign.com <mailto:support@telesign.com>`_
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 generate one in `TelePortal <https://teleportal.telesign.com>`_. If you are not a customer and would like to get an API Key, please contact `support@telesign.com <mailto:support@telesign.com>`_


Support and Feedback
Expand Down

0 comments on commit a8bda48

Please sign in to comment.