Like many companies, Code42 has an API to facilitate integration of its data into other tools and services and allow for automation. Part of my role was to create and update API documentation for the teams I supported.
For me, this meant working closely with my SME, a developer on the team supporting Alerts, to create comprehensive, complete, correct content supporting the API commands she set up in Swagger. To create this content, I:
- Worked closely with her to test my understanding and get any questions answered, as well as confirm any field values or critieria that needed to be included in the commands.
- Used Terminal on my Mac to execute the commands, perfect my syntax, and verify that I received the expected responses.
- Document each API in HTML5 according to our style guide and standards using our MindTouch/CXone authoring tool.
The resulting article is attached in PDF format, though please do forgive the formatting and artifacts as this was generated directly from the Code42 support site, which isn’t optimal.
Code42 has since migrated this content to a new Developer’s portal, and you can also see the slightly updated content in their Manage Alerts user guide there.