Google Docs
•
17th November 2016
API User Guide
This is an API Guide created for Yapstone in PDF format. Before we created an API Portal run on Apigee and maintained through Git with Apiary as the API editor, I had to create Word-to-PDF API Guides.
The Word doc was based on developer interviews, tables detailing API command values with a breakdown on code element label, description, type of code element (integer, string, etc.), whether it was a required or optional value, and any additional notes on the element. These descriptive tables informed the example XML codes that detailed the Request and Response API calls.