API: Difference between revisions

extracted documentation info that really isn't specific to API, but instead relates to Software Documentation in general
link to CiviCRM API documentation
Line 1: Line 1:
What's here: API documentation for software like mediawiki, drupal and web services.  Both API documentation and API tools. OS and Internet API references.
Commentary and examples of using the APIs for software like [http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API CiviCRM], MediaWiki, Drupal and web services.  Both API documentation and API tools. OS and Internet API references.


[[wp:ApplicationProgrammingInterface|Application Programming Interface]] ([[wp:API|API]]) is the information about the exposed or 'public' variables, methods and objects or classes that a system makes available to the developer who wishes to interface with the system programmatically.  If you make an API, documenting the API is a critical software development function.  In documentation terms, the API must almost be treated like a separate piece of software within or "attached" to the main program.
[[wp:ApplicationProgrammingInterface|Application Programming Interface]] ([[wp:API|API]]) is the information about the exposed or 'public' variables, methods and objects or classes that a system makes available to the developer who wishes to interface with the system programmatically.  If you make an API, documenting the API is a critical software development function.  In documentation terms, the API must almost be treated like a separate piece of software within or "attached" to the main program.