API Solutions

I manage your API contracts based upon the top pain points you have across your API operations. API contracts are often shaped by the mix of perspectives that exist across enterprise API operations, but we also find that just focusing on a handful of solutions to your problems will gain you the most traction--select your areas of pain below to shape your API contract.

Where Is Your Pain?

Turning on each of these areas you feel pain will light up different policies below that will help provide solutions to each areas.

Alignment
There is no alignment between product and engineering when it comes to delivering APIs.
Communication
Trouble with communication across teams producing APIs, but also with the consumers.
Reliability
The reliability of APIs, but also delivery of new versions of APIs across lifecycle.
Quality
The quality of APIs is low and doesn't deliver as expected when using over time.
Onboarding
Friction when it comes to onboarding new consumers to using and integrating with APIs.
Change
Struggle with managing and communicating change across APIs across the lifecycle.
Discovery
Difficulty finding APIs when producing new APIs, and integrating into applications.
Security
The security of APIs isn't as tight as it could be across teams producing APIs.
Access
APIs are difficult to get the proper access to when consumers are applying.
Simplicity
APIs are often complex and are not intuitive and easy for consumers to use.
Consistency
The consistency of APIs and operations around them is all over the place.
Legal
There are legal challenges that arise regularly around the usage of APIs.
Revenue
You are having trouble generating new revenue streams with your digital resources.
Provenance
There are struggles with understanding the source and history of resource evolution.

You can craft your contract based upon where you are feeling the most pain, investing in the areas that matter the most to operations.


Contract Policies By Solution

These are the API policy areas that reflect where you identified pain above, providing the properties of where you start with an API contract. You can continue to refine to match what your needs are, then submit to receive more formal feedback from me about where you need the most help.

Repository
The GitHub, GitLab, or BitBucket repository for an API, providing the single source of truth for the API contract, OpenAPI, and other artifacts, as well as the road map, change log, support, feedback, and other elements of a repository.
Metadata
Unique identifier, name, description, tags, and other metadata for the contract that defines the purpose of the API Contract, and how it benefits API producer and consumers, establishing the base of the agreement.
Use Cases
The who, what, how, and why of producing an API, making sure all of the known use cases are accurately described and kept up to date, then used to ensure each API is delivering what is expected with each use case.
Documentation
The human-readable HTML, Markdown, or PDF representation of the technical surface area of each API, providing path, methods, summaries, description, examples, and the other resources consumers will need.
OpenAPI
A machine-readable OpenAPI using the most recent version of the API specification, describing the surface area of each API, which is then used to render the human-readable documentation, and other supporting elements.
Getting Started
The step by step walk-through for new API consumers, ensuring they have exactly what is needed to discover and onboard, but also help make sure the getting started steps are as simple, plain language, and easy to follow.
Login
Providing a way to login and gain access to an API, offering a simple human-readable URL to the login page, or ideally some sort of automated login process that allows access with as few clicks and steps as possible.
Plans
Plans are all about being explicit and transparent with all of the access for an API, breaking down the tiers, rate limits, features, and pricing that is available for API consumers, standardizing the business of APIs.
Authentication
Distilling down the authentication required for an API, outlining API keys required, JWT, OAuth, and other authentication types, providing details on how to obtain accounts, tokens, and anything needed for accessing APIs.
Versioning
Providing semantic or date-based versioning for an API, offering an overview of what is adopted for an API and why, letting consumers know that their is change management in place and how they can tune into communication.
Road Map
Providing a simple yet informative look at what features are being planned for future releases of an API, or even sharing that nothing is currently being planned--just providing any insight on what the future will hold.
Change Log
Having a change log of anything added, updated, or removed for an API, but also for the other operational and supporting resources for each API, ensuring there is a easy to read manifest of what has happened for an API.
SDKs
Offering software development kits, or SDKs for an API, handling authentication, and working across all available API operations in a variety of relevant programming languages to the targeted consumers of an API.
Status
Making an API status page, monitoring reports, or other real-time updates regarding the uptime and availability of an API, providing current, but also the historical status of API, helping maintain trust with API consumers.
Performance
Publishing details regarding the performance of APIs, complimenting status and uptime information, but drilling into more detail regarding speed, latency, and other performance related metrics that matter to API consumers.
Security
Providing an overview of security practices for an API, including details covered as part of authentication and access management, but also security testing and certifications that matter to API consumers.
Support
Outline what support is available for API consumers, including email, tickets, forums, and paid support services, making it easy for API consumers to understand how they can get the help they need across APIs.
Feedback
Providing feedback on the business and technical details of each API contract, helping facilitate feedback from consumers and other stakeholders, but also from the learnings across other private and public API contracts in use.
Terms of Service
Making sure that terms of service are front and center for API consumers, ensuring that the legal side of using API resources and capabilities in applications and integrations by 3rd party consumers is covered.
Privacy Policy
Publishing a privacy policy covering the producer and consumers of an API, as well as end-users of applications, adding to the legal resources that are available to 3rd party developers when putting APIs to work.
Licensing
Publishing a license for the interface, client code, server code, and data to ensure consumers understand the legal implications of using the API, code, and data into their own applications and integrations.
Policies
Providing the machine-readable policies that link machine-readable rules with the business reasons why we are governing an API and the operations around it, helping organize rules based upon the business reasoning behind them.
Rules
Providing the machine-readable rules used to govern an API that can be used as part of pipelines or other automation to lint an API, making sure the baseline for each API and the operations around it are available as part of the contract.

Contract Support

Each API Evangelist Contract comes with a base of support services by default, helping provide a platform for each API contract to exist, while making sure questions are answered, feedback is gathered, and guidance is available for teams who are producing APIs.

Source of Truth
Establishing a single GitHub, GitLab, or BitBucket repository to manage the contract, providing a single source of truth when it comes to the API contract, as well as all of its properties supporting the evolution of the API at the center.
Questions
Empowering teams to ask questions via issue or discussion via Git repository, or directly via email about the API lifecycle, governance, as well as the business or technical elements of producing an API for wider consumption.
Feedback
Providing feedback on the business and technical details of each API contract, helping facilitate feedback from consumers and other stakeholders, but also from the learnings across other private and public API contracts in use.
Guidance
Ensuring there is guidance for teams throughout their API journey, providing simple text and video guidance for all of the topics business and engineering teams will encounter as part of their regular work to produce consistent APis.
Provenance
Helping curate the provenance of each API contract as it evolves over time, documenting change, and cataloging the reviews, validation, certification, and conversation that occurs as each API moves forward and matures over time.

Contract support services can be augmented and enhanced with strategy services, but should provide the baseline support that most teams producing APIs will need within the enterprise. API contract support services will ensure that teams don't lose their way during their API journey, and are able to move forward confidently with work producing APIs.


Contract Services


Initiate Contract

Feel free to initiate a contract for your APIs. If you are unsure of where to start, begin with a single contract and we can advise you from there. If you have question, go ahead an initiate, and we can answer your questions as we progress.

This form will send an email directly to Kin Lane, with all of the information you've provided, and you should hear back within a day about how we can help you manage your API contract(s) across your public and private APIs.

APIs are powering your business today, and we want to make sure you have the contracts in place that keep your business moving into the future.