Resident Manager API Docs
I started maintaining Eleven Software’s knowledge base while working in their customer success department. I later was promoted to thier first technical writer and quickly got into more complicated documentation, such as API docs.
The Eleven Software Resident Management API allows their customers, internet service providers (ISPs), to integrate third-party applications into their property management system (PMS).
Eleven created and documented this API before I selected Stoplight.io as the primary API documentation tool for the company moving forward. This was my first time working with the Open API Specification (OAS) and I learned a lot about how to model APIs and write API reference.
I wrote the API reference documentation in the Swagger Editor (manually editing a YAML file). I also wrote the API Overview, Access and Permissions topic, and Quick Start Guide documentation for Eleven’s knowledge base in ZenDesk.
The following links are publicly available documentation for the Eleven Software Resident Manager API. I wrote the API reference documentation in the Swagger Editor (manually editing a YAML file), displayed in Swagger UI and followed the OpenAPI Specification (OAS).
-
Resident Management API Overview (or download the PDF version)
-
Resident Management API Access and Permissions (or download the PDF version)
-
Resident Management API Quick Start Guide (or download the PDF version)