Develop APIs That Work Properly for the Organization
Leverage APIs to connect your systems in today’s web-based world.
RETIRED CONTENT
Please note that the content on this page is retired. This content is not maintained and may contain information or links that are out of date.Not managing your web API development effectively can risk:
- Developers lack a common framework for how to develop APIs.
- Application runtime issues due to the slow execution of the underlying APIs.
- Frustrated third-party developers who need to invest significant time to custom code your published APIs after each update.
- Inconsistent user experiences on different applications using the same API.
Implementing a standardized web API development process will enable your organization to:
- Consistently design, develop, and test your APIs.
- Release new and updated applications quicker because of the reusability of your APIs.
- Connect existing business products and services to more development platforms (e.g. cloud and mobile); this offers additional above-the-line and below-the-line benefits.
- Increase the quality of your business applications by providing reliable channels via APIs to deliver critical enterprise data.
Book Your Workshop
Onsite Workshops offer an easy way to accelerate your project. If you are unable to do the project yourself, and a Guided Implementation isn’t enough, we offer low-cost onsite delivery of our Project Workshops. We take you through every phase of your project and ensure that you have a road map in place to complete your project successfully.
Module 1: Examine the Opportunities Web APIs Can Enable
The Purpose
- Gauge the importance of web APIs for achieving your organizational needs.
- Understand how web APIs can be used to achieve below-the-line and above-the-line benefits.
- Be aware of web API development pitfalls.
Key Benefits Achieved
- Understanding the revenue generation and process optimization opportunities web APIs can bring to your organization.
- Knowledge of the current web API landscape.
| Activities: | Outputs: | |
|---|---|---|
| 1.1 | Examine the opportunities web APIs can enable. |
|
Module 2: Design & Develop Your Web API
The Purpose
- Establish a web API design and development process.
- Design scalable web APIs around defined business process flows and rules.
- Define the web service objects that the web APIs will expose.
Key Benefits Achieved
- Reusable web API designs.
- Identification of data sets that will be available through web services.
- Implement web API development best practices.
| Activities: | Outputs: | |
|---|---|---|
| 2.1 | Define high-level design details based on web API requirements. |
|
| 2.2 | Define your process workflows and business rules. |
|
| 2.3 | Map the relationships among data tables through ERDs. |
|
| 2.4 | Define your data model by mapping the relationships among data tables through data flow diagrams. |
|
| 2.5 | Define your web service objects by effectively referencing your data model. |
|
Module 3: Test Your Web API
The Purpose
- Incorporate APIs into your existing testing practices.
- Emphasize security testing with web APIs.
- Learn of the web API testing and monitoring tool landscape.
Key Benefits Achieved
- Creation of a web API test plan.
| Activities: | Outputs: | |
|---|---|---|
| 3.1 | Create a test plan for your web API. |
|
Module 4: Monitor and Continuously Optimize Your Web API
The Purpose
- Plan for iterative development and maintenance of web APIs.
- Manage web APIs for versioning and reuse.
- Establish a governance structure to manage changes to web APIs.
Key Benefits Achieved
- Implement web API monitoring and maintenance best practices.
- Establishment of a process to manage future development and maintenance of web APIs.
| Activities: | Outputs: | |
|---|---|---|
| 4.1 | Identify roles for your API development projects. |
|
| 4.2 | Develop governance for web API development. |
|