Let’s take a look at why using, or avoiding, an API for your favorite application makes sense. Then determine what is involved in a successful integration.
First off, you might be asking what is an API and why would you need one. Well, an API is an Application Programming Interface; and don’t worry, if you don’t know what that is, it doesn’t mean you shouldn’t be using one. In layman’s terms an API is a translator that allows 2 pieces of software to communicate. You can take a longer look at what an API is and get familiar with API lingo in our recent post: API – Driving Your Email Marketing Forward
[Above is an example of the API process. All APIs function differently, but the diagram outlines the general idea of how an API works.]
Is an API right for You?
When reviewing the reasons for why you would want to use an API for an application, and especially a SaaS (Software as a Service) like Bronto, you should consider the following elements:
Documentation
Does the API have an abundance of documentation, including examples with response and result definitions? Because an API is really an abstract that specifies the interface and behaviors of the interface, having the proper documentation is key to a successful implementation of the API. Look for a defined list of objects and functions, as well as a few sample scripts to get your started, preferably in a variety of programming languages.
Sand Box and Testing
Having a testing area for you to try out the API is critical. Using 2 active pieces of software to work out all of the inevitable kinks, is an immeasurable task. Most larger applications and services that provide an API will have one, however not having one shouldn’t be a deal breaker. It should just change your approach to a less radical and experimental one. Once you have access to a test account or testing area, you can begin to really get a feel for how the API works without potentially damaging your existing data.
Alternatives to the API
Is using the API the most efficient solution for your needs, or is there an easier way? Many times there will be other possibilities for integration that are not as complicated as an API. These solutions may not be as robust, but you might not be ready for that at this time. Look into what other ways you can get your information from one source to another, and evaluate all of your options before jumping in feet first. Many times there will be a simple way to pass your information to an application via simple HTML, using a web form or via a query string in a URL. Remember, the simplest tool to do the job is almost always the best tool.
[Above you can see some other processes for moving data. There are other options as well, you should always use the option that is right for you.]
Are you prepared for an API?
Now that we have highlighted some things to look for in an API, we need to begin thinking about what to look for at your company. Remember, an API is an interface, not an application and it requires that you develop software to connect the API to your software.
Software Development
Are you, or do you have access to, a software developer or a group of developers? Remember, the API is just an adapter, YOU need to be able to create the software that will connect to the API and carry out your desired integration. This includes pulling the data from your system and packaging it to be sent, then processing the responses you receive. Most often this level of integration is not rocket science, however, it truly does require real software development skills and experience and should not be attempted by a novice.
Organized Data
Is your data already stored and organized in a format, such as a database, that is consistently updated and maintained? Is this data source accessible to the web, in other words can the information be accessed remotely or is it stored in a spreadsheet on your computer? If your data is stored within another SaaS application, is it accessible via an API? The way you store and maintain and access your data says a lot about how prepared you are for building an API connection. If your information is not ready to be accessed easily, then building software to access it will be nigh on impossible.
Integration Plan
Along with having the right personnel and the right data, you need the right plan. It is a critical business choice to use an API. Knowing what information you want to pass along from your data source, as well as what information you want to receive from the other software. Are you planning to synchronize the data? What information will be the master, how will records be updated? Remember that throughout this process you need to know what you are expecting to happen as a result of this integration.
OK, that makes sense… What now?
The important thing to remember is that the responsibility remains with you. Just like any other business endeavor you undertake, you should ensure that this is the right solution for your business needs, and that it is a project your company has the resources to undertake. You need to make sure the API you want to use is not only the best solution for your business, but has all of the necessary components and features. You also need to determine if you can provide the development to make an API work.
An API is not a magic bullet to solve your disparate software woes. However, an API that has the right resources dedicated to the development process can be an extremely effective tool in creating a seamless integration.
Jason Malone
Support Associate at Bronto
Related posts:
- The Bronto Fall 2008 Release is Approaching At Bronto we are always working to make your life...
- New Pricing and Editions Big changes are happening at Bronto. We are changing our...
- API - Driving Your Email Marketing Forward An API is a powerful tool that can open the...
{ 0 comments… add one now }