Skip to content
Snippets Groups Projects
Commit b9940bf1 authored by Sean Madsen's avatar Sean Madsen Committed by GitHub
Browse files

Merge pull request #248 from eileenmcnaughton/patch-1

Remove references to whether apis are supported
parents 420bc4b5 173fed17
No related branches found
No related tags found
No related merge requests found
# API architecture # API architecture
The term 'API' refers to that code accessible by the api wrapper. To be accessed by the wrapper
the code must be in a directory that equates to `$path/api` and the core api functions are
the top level api folder.
The term 'API' refers to that code stored in the top level api folder. Usage documentation is in the [APIv3](/api/index.md) page.
It's important to note that only compliant code & usage will be
supported. Usage documentation is in the [API
v3](/api/index.md) page.
## Standards {:#standards} ## Standards {:#standards}
...@@ -13,12 +13,6 @@ v3](/api/index.md) page. ...@@ -13,12 +13,6 @@ v3](/api/index.md) page.
* JavaScript: by using `CRM.api()` (or preferably `CRM.api3()`); * JavaScript: by using `CRM.api()` (or preferably `CRM.api3()`);
* Smarty: by using the [Smarty interface](https://wiki.civicrm.org/confluence/display/CRMDOC/Smarty+API+interface) * Smarty: by using the [Smarty interface](https://wiki.civicrm.org/confluence/display/CRMDOC/Smarty+API+interface)
* REST: by using the [REST interface](https://wiki.civicrm.org/confluence/display/CRMDOC/REST+interface) * REST: by using the [REST interface](https://wiki.civicrm.org/confluence/display/CRMDOC/REST+interface)
- Functionality delivered by the API is only supported if it is
1. Advertised via the 'getfields function' OR (preferably AND)
2. Verified by a test
- Where functions sit on the api but don't conform to the api
standards they may be supported by the creators but not by the
api team.
## Individual functions ## Individual functions
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment