I've noticed that vauschnik has uploaded a C# Library for the Betavine API. I haven't really used C# so can't really test it. Has anybody given it a go?

Owen.

Hi, All.

At the moment Betavine is having problems sending messages to the United States through it's Spanish connection. We've reported this problem to our collegues and hopefully are looking into it.

Sending messages using the API to a US mobile may not work depending on the operator. For the time being use the trigger API method call to send an SMS and specify a random port number.

Thanks,

Owen.

What is an API?

An API is an Application Program Interface. The Betavine API is a Web API, which means that it is accessible through the Internet using HTTP.

Why is Betavine launching an API?

For developers, we hope the API will become a useful tool and an incentive to develop applications with Betavine. We are particularly keen to see how Internet-based applications or mashups can use mobile comunications APIs in (such as messaging) to create new and innovative services. We hope the APIs we offer will help developers achieve this.

How much does the API cost to use?

You are not directly charged for using the API although we control usage through a credit based system. When you register as a user or developer on the site, you will be awarded credits (our initial allocation is 100). This will allow you to test and/or develop applications that use our messaging API.
You can see how many credits you have remaining from the API Home.

What happens if I run out of Credit?

All registered users will initially be given 100 credits. With the current release of our API, there is no automatic way to 'top up' your credit (we are currently working on a variety of mechanisms to do this). If you would like more credit, simply drop an e-mail to 'webmaster@betavine.net' with the subject 'credit request' and will contact you to arrange a top-up.

What is the UAID used for?

A UAID (User-Application Identifier) is a key that is used to uniquely identify the user and the application or mashup being used. One of the main drivers for introducing the UAID is so developers can get see how many different users have tried their application. (The UAID will not be used to pass on your personal details to the developer). It also helps the Betavine web team identify any fradulant activity with the APIs.

What happens if somebody steals my UAID?

Be careful with your UAIDs, another user can use your UAID to access the Betavine API. This will result in you loosing your credit, and other users masquerading as you.

Keep track of which applications are using your credit by using the API Usage page. If you suspect that someone else is using your UAID then follow the 'Renew' link. This will give you an entirely new UAID for you to continue using with your application.

Application XXX does not work!

Oops! The developer which wrote that application will probably want to hear about it. Use the discussion forums or leave them a message on their blog.

How do I write a Mashup for the Betavine API?

If you would like to use or write a mashup which uses our API then you need to generate a Mashup Key.

The Betavine API has two modes of operation; a Test mode and an Live mode. The Test mode simulates the response of API calls without sending messages whilst the Live mode is fully functional and the messages will be sent. When you are developing your application use the Developer mode. When you upload your application onto Betavine then it will use the Live mode. To determine if an application is using Test mode or Live mode the Betavine API uses a User Application IDentifier.

The User Application IDentifier, or UAID, uniquely identifiers a user to an application. This allows an Application to send messages originating from the User without having any knowledge of their mobile number. When an application is in Test mode it is using a Developer Key as a UAID. To get a developer key visit Generate a Developer Key. Once you have your Developer Key you can start interfacing with the API. However you still won't be able to send messages until you have uploaded your Application onto Betavine.

For an application to use Live mode it needs to be uploaded onto Betavine. When a user downloads an application which uses the API they are provided with a UAID. This UAID will give the application permission to send messages on behalf of the user. To use the Betavine API your application will have to be able to accept a user's UAID. How you do this is up to you. It may be a Dialogue box, in a Preferences window or as a command line argument. Don't include your Developer Key in your application - none of your users will be able to send any messages.

As a developer you can force your application to use Live mode by using a UAID from a different application. But be careful not to distribute this UAID. If others do get hold of your UAID then they will be able to send messages from your number.

For more information on these concepts look at the API Reference Guide

We've put together a guide to explain how Application Trigger SMS messages can be used:

Take a look at the Application Trigger Tutorial


Pete