API Integration Tutorial
API Integration Tutorial
In this tutorial
In this tutorial:
A roundup of the leading API
As application program interface integration increases, so do the
management tools available challenges with maintaining management, testing, and security.
today………………………………..…. p.2
This API integration tutorial compares leading API management
What are some solid options tools currently available on the market, as well as strategies for
for open source API RESTful API testing.
management tools?.............. p.14
About
SearchMicroservices.com
……………………………………………. p.31
Page 1 of 31
Tutorial
In this tutorial
A roundup of the leading API management
A roundup of the leading API tools available today
management tools available
today………………………………..…. p.2 Zachary Flower, Freelance writer, SearchMicroservices.com
Page 2 of 31
Tutorial
3scale is an incredibly flexible API management platform from Red Hat Inc.
In this tutorial Unlike many of the API management tools on this list, 3scale has a very self-
serving product offering, which has resulted in a very affordable and flexible
A roundup of the leading API
platform. The low barrier-to-entry of the 3scale platform allows
organizations to slowly scale up their API(s) both architecturally and
management tools available
financially, rather than having to make a high-cost commitment on a brand
today………………………………..…. p.2
new service. Although 3scale does offer both on-site and cloud-based
delivery methods for the API management platform, its particular brand of
What are some solid options delivery is unique in that the on-premises gateway is built around the NGINX
for open source API server. This gives organizations the flexibility to use whatever infrastructure
management tools?.............. p.14 best suits their needs. Additionally, 3scale integrates directly with popular
cloud providers Heroku, Amazon Web Services and Red Hat OpenShift for
more rapid deployments.
The basics of establishing a
RESTful API testing program While 3scale has incredibly flexible delivery methods, the feature that stands
……………………………………………. p.17 out the most is the end-user experience. 3scale operates under the
philosophy that API success is dependent on creating an awesome
Testing microservices and developer experience. This attitude has led to the creation of engaging
APIs in the cloud……………... p.24 developer portals and live Swagger-based documentation for a dynamic,
usable developer experience.
How do I create a secure API Starting at $50 per month, 3scale's base package is incredibly financially
for mobile?............................... p.29 approachable. This base package includes the most desirable features in an
API management platform, including rate limiting, analytics, a developer
About
portal and key management. The next package up from there, starting at
SearchMicroservices.com
$150 per month, adds API monetization and multiple apps per account to the
list of features. The final tier, priced at $750 per month, is aimed at larger
……………………………………………. p.31
organizations with multiple APIs, users and administrators. 3scale does offer
Page 3 of 31
Tutorial
Page 4 of 31
Tutorial
While Apigee has some great analytics tools, what really sets it apart are its
How do I create a secure API
monetization tools. With Apigee, organizations can monetize their APIs in a
for mobile?............................... p.29
multitude of unique ways, from offering free trials based on time or API call
volume to charging users based on usage or a flat fee over time. However,
About Apigee has added a truly unique twist to this feature: revenue-sharing
SearchMicroservices.com capabilities that allow organizations to share revenue with their own API
……………………………………………. p.31 consumers. This gives organizations the ability to not only charge a
percentage of revenue generated by API consumers, but also gives that
Page 5 of 31
Tutorial
The basics of establishing a Microsoft is a relative newcomer to the field of API management, especially
RESTful API testing program when compared with a few of the other API management tools in this
……………………………………………. p.17 roundup. The Azure API management platform is a cloud-based gateway
targeted toward organizations of all sizes, starting at just $50 per month and
scaling up as needed. While the Azure API management platform will work
Testing microservices and with any host via a direct or virtual private network connection, the big
APIs in the cloud……………... p.24 advantage to using the platform is its direct integration with the rest of the
Azure ecosystem.
How do I create a secure API
With direct support for services like the Azure Active Directory and the
for mobile?............................... p.29
ability to work seamlessly with Azure virtual networks and ExpressRoute,
the Azure API management platform is the perfect choice for organizations
About that are already consuming the Azure ecosystem. Beyond the obvious
SearchMicroservices.com integrations within its own architecture, getting started with the Azure API
……………………………………………. p.31 management platform is as easy as importing an existing Swagger
Page 6 of 31
Tutorial
While the CA API Management platform shares many of the same features
Testing microservices and as other offerings, such as a developer portal, endpoint management and
APIs in the cloud……………... p.24 analytics, the thing that makes it stand apart is its emphasis on mobile API
management. The feature that highlights this support is the CA Mobile API
Gateway. This is an API gateway that provides mobile-friendly API design
How do I create a secure API
and is specifically tailored to handle things like security, identity, adaption,
for mobile?............................... p.29
optimization and integration. By providing software development kits (SDKs)
and granular security policies, the CA Mobile API Gateway can drastically
About speed up application development and deployment, while also ensuring a
SearchMicroservices.com safe and secure API environment.
……………………………………………. p.31
Page 7 of 31
Tutorial
Page 8 of 31
Tutorial
logs across all of these platforms. This allows development teams to spend
In this tutorial less time dealing with the nuances of third-party API integrations and more
time building and managing a reliable product. With very little effort, an
A roundup of the leading API
existing API can be integrated directly with Salesforce, SendGrid, Slack and
even JIRA, making it possible for organizations to use the tools they are
management tools available
already familiar with to manage the health of their API.
today………………………………..…. p.2
Page 9 of 31
Tutorial
Though not open sourced like Kong, Mashape also offers a powerful
In this tutorial commercial API analytics platform called Galileo and a commercial
developer portal platform called Gelato. These two services can move an
A roundup of the leading API
existing API from the private to the public space by adding tools that are
important to product stakeholders and API consumers. Galileo accomplishes
management tools available
this with analytics tools that provide real-time logging of API calls, request
today………………………………..…. p.2
replaying, usage statistics and even error alerting. These are desirable
features for product managers and development teams alike, as they give
What are some solid options total insight into what is and isn't working within an API. Gelato, on the other
for open source API hand, provides a drop-in public face to an API. With Swagger and API
management tools?.............. p.14 Blueprint support, developer registration management, a live API explorer,
and even markdown management of API documentation, Gelato is an
excellent developer portal product.
The basics of establishing a
RESTful API testing program
……………………………………………. p.17
Mashery
Testing microservices and Cost: Not provided
APIs in the cloud……………... p.24 License: Commercial
Market: SMB/Enterprise
How do I create a secure API Delivery: Proxy/Agent/Hybrid
for mobile?............................... p.29
Mashery from TIBCO Software Inc. is an API management platform
designed and built with ease-of-use in mind. While not as enterprise-leaning
About as other platforms, Mashery is still a good fit for small to medium-sized
SearchMicroservices.com businesses that are beyond the early startup stage. This is evidenced
……………………………………………. p.31 through TIBCO Software's direct sales-driven funnel approach, which is a
change from the more organic, self-serve onboarding process found
Page 10 of 31
Tutorial
MuleSoft
Testing microservices and
APIs in the cloud……………... p.24 Cost: Not Provided
License: Commercial
How do I create a secure API Market: Enterprise
for mobile?............................... p.29
Delivery: Proxy/Agent/Hybrid
Page 11 of 31
Tutorial
WSO2
Testing microservices and
APIs in the cloud……………... p.24 Cost: Starting at $0 per month
License: Apache 2.0
How do I create a secure API Market: Startup/SMB/Enterprise
for mobile?............................... p.29
Delivery: Proxy/Agent/Hybrid
WSO2 is, by far, the most popular and feature-complete open source API
About management platform on the market today. It provides everything from
SearchMicroservices.com design and prototyping tools to developer tools and traffic
……………………………………………. p.31 management. While WSO2 is loaded with the same features found in the
other leading API management tools, what really makes it special is the
Page 12 of 31
Tutorial
About In the end, the most important thing to remember when evaluating any new
SearchMicroservices.com DevOps platform is that getting the buy-in from your entire team determines
……………………………………………. p.31 success far more than how many bells and whistles any one platform has.
Page 13 of 31
Tutorial
In this tutorial
What are some solid options for open
A roundup of the leading API source API management tools?
management tools available
today………………………………..…. p.2 Twain Taylor, Freelancer, SearchMicroservices.com
APIs are the fuel that powers all interactions between applications behind
What are some solid options the scenes. APIs have become essential to enabling services to talk to each
for open source API other, especially as more enterprises shift to distributed architectures, like
management tools?.............. p.14 microservices.
While many tend to go the commercially supported API route and make use
The basics of establishing a of proprietary tools, an increasing number of organizations are making use
RESTful API testing program of publicly available open source tools. Let's look at the top open source API
……………………………………………. p.17 management tools available today
Page 14 of 31
Tutorial
Based on plug-ins, Kong is easy to extend and has ready-made plug-ins for
In this tutorial many popular services. For example, it can be used to manage and invoke
Amazon Web Services Lambda functions, and monitoring data can be sent
A roundup of the leading API
to a monitoring tool, like Datadog, or a logging service, like Loggly.
management tools available
today………………………………..…. p.2
Tyk
What are some solid options Tyk is another capable open source API management tool. It can be set up
for open source API by yourself on premises, or you can pay to use a version hosted by Tyk. A
management tools?.............. p.14 recently launched Kubernetes integration also lets you set up Tyk in a
Google Cloud Kubernetes container cluster. Central to the Tyk experience is
The basics of establishing a its API gateway; it's actually Tyk's API that lets you manage your own API
RESTful API testing program requests.
……………………………………………. p.17
Tyk is evolving quickly, and you'll need to keep a close watch on all its
releases since many come with major updates. Tyk claims that v2.3 can
Testing microservices and handle more than double the traffic of v2.2. This fast pace of development
APIs in the cloud……………... p.24 makes it hard to document every change adequately. Some very new
features may not be included in the main product documentation and are
found in the release notes. While Tyk does report on performance and error
How do I create a secure API
metrics, it could do better at showing the details of the errors, which can
for mobile?............................... p.29
help with root cause analysis.
About Like Kong, Tyk is also easy to extend. There are already integrations with
SearchMicroservices.com many tools, such as logging integration with Logstash. You can also write
……………………………………………. p.31 plug-ins for Tyk in a range of languages, including gRPC and Python. You
Page 15 of 31
Tutorial
should plan on eventually integrating plug-ins into the open source software
In this tutorial core of Tyk.
A buzzing market
How do I create a secure API
for mobile?............................... p.29 Clearly, the market for open source API management tools is buzzing with
activity, and you'd be spoiled for choice trying to pick the best among them.
In addition to the tools mentioned above, you should also consider taking a
About look at WSO2, ApiAxle and Fusio offerings.
SearchMicroservices.com
……………………………………………. p.31
Page 16 of 31
Tutorial
In this tutorial
The basics of establishing a RESTful API
A roundup of the leading API testing program
management tools available
today………………………………..…. p.2 Greg Sypolt, Senior Engineer, Gannett
The standard practice of testing web applications for many years was
What are some solid options heavily front-end graphic user interface tests. Recently, the standards of
for open source API testing have undergone a makeover from top to bottom. To move toward a
management tools?.............. p.14 modern delivery pipeline, such as continuous integration or continuous
delivery, teams need to be at least versed in automation, and focus must
shift upon preventing bugs by building in quality upfront and efficiently.
The basics of establishing a
Developers, product managers, business analyst and QA team members
RESTful API testing program
must begin by planning and building a better testing portfolio. As they start
……………………………………………. p.17
working closely together, they will begin to identify what they need to meet
the acceptance criteria and determine as a team what the best way to test
Testing microservices and is. This also requires following the "testing pyramid methodology" by
APIs in the cloud……………... p.24 creating more lower-level tests -- API tests, for instance -- creating a smaller
percentage of UI tests in the end.
How do I create a secure API This journey starts with RESTful API testing. At the end of this article, you
for mobile?............................... p.29 will have a better understanding of why API testing is necessary, its key
physical and logical layers, how to design a testing blueprint for APIs, and
About the technologies available to help.
SearchMicroservices.com
……………………………………………. p.31
Page 17 of 31
Tutorial
In this tutorial
What is a RESTful API?
A roundup of the leading API In simple layman's terms, REST is a way for two computers to communicate
management tools available with each other over the internet. One acts as a web browser, and the other
today………………………………..…. p.2 acts as a web server. The transfer happens over the web, which
communicates through HTTP/HTTPS protocols. The HTTP request
methods performed are GET, PUT, POST and DELETE.
What are some solid options
for open source API The two commonly used methods are GET and POST:
management tools?.............. p.14
• GET is used for retrieving data from a specified resource.
The basics of establishing a • POST is used for creating data to be processed to a specified
RESTful API testing program resource.
……………………………………………. p.17
An example of this is the GitHub API for repository_url, shown below:
The moment the HTTP request is fired it will begin communicating with the
Testing microservices and layered architecture.
APIs in the cloud……………... p.24
Page 18 of 31
Tutorial
In this tutorial
Presentation
A roundup of the leading API The top-most layer of the application is the user interface, which translates
management tools available the response into machine readable format for users to understand. The
today………………………………..…. p.2 presentation layer takes care of content representation, shown here:
About
SearchMicroservices.com
……………………………………………. p.31
Page 19 of 31
Tutorial
In this tutorial
Data Storage
A roundup of the leading API The data storage layer will consist of a relational database management
management tools available system, NoSQL database, file system, remote storage in the cloud or in-
today………………………………..…. p.2 memory.
Page 20 of 31
Tutorial
In this tutorial
Selecting a Testing Technology
A roundup of the leading API The options can be overwhelming; there are lots of open source tools,
management tools available vendor tools and custom testing harnesses. It's useful to think practically
today………………………………..…. p.2 about your requirements while evaluating any testing technology.
About
SearchMicroservices.com
……………………………………………. p.31
Page 21 of 31
Tutorial
In this tutorial
Responsibilities
A roundup of the leading API Clearly outline each team member's responsibilities for developers, QA,
management tools available DevOps teams and product managers.
today………………………………..…. p.2
Page 22 of 31
Tutorial
Here are some of the tools or frameworks are widely used for automating
A roundup of the leading API
API testing:
management tools available
today………………………………..…. p.2
Open Source Vendor Custom
What are some solid options Frisby.js + Jasmine SoapUI Pro NodeJS
for open source API
management tools?.............. p.14
Chakram Smart Bear
REST-assured Runscope
The basics of establishing a
RESTful API testing program Swagger
……………………………………………. p.17
Vows + api-easy
Page 23 of 31
Tutorial
In this tutorial
Testing microservices and APIs in
A roundup of the leading API the cloud
management tools available
today………………………………..…. p.2 Tom Nolle, President, CIMI Corp
The Internet and cloud computing are quickly shifting application focus from
What are some solid options SOA and service busses to microservices and RESTful design. Application
for open source API architects and developers find the new models to be more agile, but the very
management tools?.............. p.14 cloud environment that's helping to spawn both trends is making testing
microservices and RESTful APIs notoriously difficult.
The basics of establishing a To avoid being "trapped in flexibility," developers need to first understand
RESTful API testing program the issues of multidimensional agility the cloud presents, build an approach
……………………………………………. p.17 by applying abstraction principles effectively to reduce complexity, and
design services and APIs to be flexible in the functional and deployment
Testing microservices and dimensions without becoming disorderly.
APIs in the cloud……………... p.24
Application agility, meaning the ability of application development to quickly
address changes in business needs and opportunities, is increased in large
How do I create a secure API part by componentization and component reuse. Rather than building a
for mobile?............................... p.29 totally new application every time something is needed, componentized
development builds an inventory of reusable components that can be easily
assembled and reassembled.
About
SearchMicroservices.com
Cloud computing also improves agility by shortening the deployment cycle
……………………………………………. p.31 through the use of public server pools and by facilitating application scaling
Page 24 of 31
Tutorial
Page 25 of 31
Tutorial
is that the implementation of microservice and REST can collide with cloud
In this tutorial resource mapping. Fortunately, that can be fixed if you take care in how
your abstractions are created in the first place.
A roundup of the leading API
A microservice or API is not a singular web server; that violates the principle
management tools available
of abstracting features from implementation. Thus, microservices and APIs
today………………………………..…. p.2
should be viewed as a gateway to an agile collection of implementations
below. Experienced cloud developers have said: it's essential to have to
What are some solid options view a microservice or RESTful API as a virtual connection that, when
for open source API implemented, includes agile resource positioning through DNS or other
management tools?.............. p.14 directory services, load balancing to manage work among instances, and
management of collective resources against singular virtual
presence. That's exactly correct; the key to testing microservices and APIs
The basics of establishing a
in the cloud successfully is the abstraction of the services and APIs to
RESTful API testing program include the resource allocation and component scaling features to be used,
……………………………………………. p.17 both in terms of objectives to be met and practices to be employed. This will
enable a test plan to include the cloud-related elements and deal with cloud
Testing microservices and quality of experience.
APIs in the cloud……………... p.24
Preparing a test plan of this type means including not only the expected load
variations, QoE or scalability requirements, but also what the cloud
How do I create a secure API implementation is expected to do to respond to them. While the number of
for mobile?............................... p.29 specific things such a plan has to address varies depending on the
application, in general it will be important to do each of the following:
About
• Identify the specific way in which application component locations are
SearchMicroservices.com
registered on deployment, including the time required.
……………………………………………. p.31
Page 26 of 31
Tutorial
Page 27 of 31
Tutorial
issues. With a little effort, microservice and API design and testing in the
In this tutorial cloud can become routine.
About
SearchMicroservices.com
……………………………………………. p.31
Page 28 of 31
Tutorial
In this tutorial
How do I create a secure API for mobile?
A roundup of the leading API Matthew David, Leader, Mobile Center of Excellence, Kimberly Clarke
management tools available
today………………………………..…. p.2 Security is often an issue that arises when dealing with mobile devices. And
as APIs have garnered increased importance with regards to mobile
development, the need to create a secure API for that development becomes
What are some solid options
important as well. Here we examine the steps needed to create a secure API
for open source API for mobile.
management tools?.............. p.14
Inherently, all mobile devices are insecure. The approach to developing
The basics of establishing a
mobile apps is to secure all of the parts at play. APIs are an effective way to
RESTful API testing program
deliver solutions across multiple platforms -- think of Google Maps, one of
……………………………………………. p.17
the most popular API libraries -- and it is good to develop a secure API for
mobile, ensuring it's locked down tight.
Testing microservices and There are several steps to achieving a secure API. They include:
APIs in the cloud……………... p.24
• Data at rest and data in transit. Your API will move data back and
forth across the cloud and to devices. Leverage HTTPS to protect
How do I create a secure API
your data in transit and encrypt the data when at rest on the server
for mobile?............................... p.29
and the client.
• API keys. Create APIs that require developer registration. The focus
About for API keys is to lock down and know which apps are using your
SearchMicroservices.com APIs. The API key is unique to each developer and should be stored
……………………………………………. p.31 on your server in Base64 encryption.
Page 29 of 31
Tutorial
What are some solid options The goal is to protect the data on the cloud server as it moves to the API;
for open source API use tools that ensure the data is encrypted as it is stored on a device; and,
management tools?.............. p.14 finally, only show data with the correct authentication. This level of security
is required for a secure API for mobile. Easy, right?
The basics of establishing a
RESTful API testing program
……………………………………………. p.17 About SearchMicroservices.com
About
SearchMicroservices.com
……………………………………………. p.31
Page 30 of 31
Tutorial
In this tutorial
About SearchMicroservices.com
A roundup of the leading API
management tools available Over 4 million programmers, architects, IT managers, and
today………………………………..…. p.2 developers turn to our site for industry news, expert advice and
peer-to-peer learning opportunities around managing
What are some solid options
microservices and service-oriented architecture (SOA),
for open source API
management tools?.............. p.14 application modernization and digital transformation, Business
Process Management (BPM), application integration and APIs,
The basics of establishing a software containers and microservices design and development,
RESTful API testing program DevOps, and more.
……………………………………………. p.17
About
SearchMicroservices.com
……………………………………………. p.31
Page 31 of 31