API Documentation
API documentation is important to me - as APIs are essentially the keys to any company’s castle, an API-first company is one that thinks about product efficiency and flexibility. Though all of these samples are built for Swagger, I do have experience in Postman and have attended in the API the Docs conference.
By viewing this page and downloading these samples, you agree to not share these APIs outside of our conversations. Though they have been changed significantly to preserve the confidentiality and intellectual property of the companies who own them.
Using these samples…
You can view these samples in their Swagger format by importing the JSON file to Swagger Editor (one at a time!). Or, if you’re cool like that, just read the JSON in Atom or something - straight, no chaser, am I right?
API Sample 1
Built to empower insurance companies as they determine the amount of cyber risk they can take on in a given year. This set of endpoints allows insurers to pull our risk model, which focuses on cyber, into their other systems, which may focus on other areas of insurance. This allows them a wholistic view of their portfolios, showing cyber losses alongside other types of losses.
I worked directly with the Product Manager on the inception and creation of these APIs, as she had never worked with APIs before and I had experience.
*Endpoints and other elements are changed to preserve the company’s IP.
Displayed on: Private Swagger Account & the company’s Internal Gated Documentation Site
API Samples 2 & 3
Similar to the Cyber Catastrophe MI APIs, these APIs reflect two of the company’s other products, which focus on single account-level cyber risk analytics. They’re very similar APIs, which diverge when it comes to output - do you want Risk Scores or do you want a full Risk Analysis?
*Endpoints and other elements are changed to preserve the company’s IP.
Displayed on: Private Swagger Account & the company’s Internal Gated Documentation Site
API Sample 4: Braze APIs
Displayed on Braze’s documentation site, these APIs allowed customers to use the Braze product programmatically and to scale, as marketing and messaging campaigns often depend on agility and consistent rules (Has a shopper already seen this discount code? Yes? Great - let’s not show them the same message twice and waste money. Let’s show them this instead and convert them to buy).
I have linked to historical files on Github, as the API documentation has been updated since I left Braze.
Displayed on: Braze’s Documentation Site