Getting Started Using Kermit
This tutorial will walk you through the steps for making your first call application using Ribbit's tool, Kermit, a sample JavaScript REST test harness that shows off what
the REST API can do.
Prerequisites
1. Sign Up as a Ribbit Developer
2. Start an Application in a private Domain so that you can create Users for your Application.
1. Sign Up as a Ribbit Developer
2. Start an Application in a private Domain so that you can create Users for your Application.
Step 1: Open the Kermit REST Test Harness
Once you have downloaded Kermit, unzip the file and click index.html to open the REST test harness in your default browser. If your browser asks for permission to run the Kermit REST test harness, you will need to grant it. The opening screen should look like this:
Step 2: Add Your Project Information to Kermit
The project you created in Step 1 has an Consumer Key and a Secret Key. Cut and paste those two numbers into Kermit.Step 3: Create a User
For an application to do something useful, a user first must be created. To do this, click Resource and select Users from the drop down menu. Then click createUser. It should look like:
Complete the form creating a login ID and password. You may want to assign the user a first and last name, but this is optional. When you are finished, click Post. You should see the JSON request and response.
Step 4: Authenticate the User
Next, you need to login as the user you created. Do this by clicking the Authentication button. You can now add the user you created in Step 4 and login.
Step 5: Add the New User to the Billing Account
To utilize much of Ribbit's functionality, users need to be set up for billing. To do this, login to your Ribbit developer account and select your application from MyApps. You will see a Configuration menu to the left of your account information. Click Users to return a list of users. From this list click Add to add the user to the billing account.Step 6: Add a Purpose Number to the User
A purpose number is an inbound number and a Device resource type. We will create a purpose number so that we have a phone number where we can call and leave a voicemail. In Kermit, click Resource and select the Device resource from the drop down menu. Just as we created a User, we will now create a Device. In the ID box, enter @purpose/USA or @purpose/GBR (as appropriate for your country), give your device a name, and click commit. You'll see the response HTTP Status - 201 if it was successful. Below that, under the Result heading, you'll see ribbit:<phone_number>. The phone number is the purpose number you'll use in the next step.
Step 7: Add an Email Address to the User
Now that we have a phone number we can call and leave a voicemail, we need an email address where we can send notifications of new messages. We will again create a Device resource. This time, instead of creating a purpose number with the @purpose/USA or @purpose/GBR (as appropriate for your country) in Step 7, we will create a email destination with the "mailto:" directive. Add an email address in the ID box. An email should be sent to your account. You'll need to verify that email address.Step 8: Try it Out
Click Resource, select Devices, and click GET. You'll see the email address you just created as well as the purpose number. There is also a default Device that was created when you created a User. Call the purpose number and leave a message. When you check your email, you should see a new message. That message has some information about the phone from which you just called, and (more importantly) an attached MP3 file of the call itself. You've just created your first application.