Preparing Documentation

  • Documentation should be markdown format
  • You can refer here for markdown documentaion in online
  • You can use markdown editors for create your own markdown

Sections of the Documetation

API Description
API Flows
Authorization (same as other APIs) ( refer http://docs.ideabiz.lk/APIs/PIN-Verification)
API Methods
  • URL
  • Method
  • Request Sample
  • Request parameter table
  • Sample success response
  • Response code and parameters table
  • Other responses

Other notes and error codes

for example you can refer this API format

Last updated on 11th Jan 2017