meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
api [2023/09/14 16:20] – [API Docs/Examples] johnny | api [2024/02/10 07:15] (current) – wrongecho | ||
---|---|---|---|
Line 10: | Line 10: | ||
* assets | * assets | ||
* certificates | * certificates | ||
+ | * clients | ||
* contacts | * contacts | ||
* domains | * domains | ||
Line 44: | Line 45: | ||
==== Notes ==== | ==== Notes ==== | ||
- | * For read requests, 50 records are shown by default. This can be adjusted by supplying the limit and offset parameters. | + | * For read requests, 50 records are shown by default. This can be adjusted by supplying the '' |
- | * For POST requests, the client_id parameter is always required if the API key used has scope/ | + | * For POST requests, the '' |
+ | * Be sure to check your Apache/PHP error logs if you're running into issues | ||
==== API Docs/ | ==== API Docs/ | ||
Line 51: | Line 53: | ||
Documentation / an example of how to use a module API endpoint is shown on that module' | Documentation / an example of how to use a module API endpoint is shown on that module' | ||
- | |||
- | === Old API === | ||
- | |||
- | The legacy ITFlow API is accessed at /api.php. We are working on moving all functionality into the new API at /api/. The legacy API has the following features: | ||
- | |||
- | * Caller ID lookup (Great for integrating with your phone system like FreePBX, and having your VOIP phone return the client' | ||
- | * XML Phonebook Download - / | ||
- | * Client Email (great for mailing lists) - / | ||
- | * Account Balance for Client (can be integrated into multiple places for example in FreePBX Press 3 to check account balance, please enter your client ID your balance is) - / | ||
- | * Add new asset for a client - / | ||
- | * Required: api_key, client_id, add_asset (name) |