meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
api [2023/09/14 20:15] – [API Docs/Examples] johnnyapi [2024/08/29 22:50] (current) – [Generating an API Key] Mention all clients/specific wrongecho
Line 10: Line 10:
   * assets   * assets
   * certificates   * certificates
 +  * clients
   * contacts   * contacts
 +  * credentials (logins)
   * domains   * domains
   * networks   * networks
Line 20: Line 22:
  
   * read   * read
-  * create (partial) +  * create //(partial)// 
-  * update (partial)+  * update //(partial)// 
 +  * delete //(partial)//
  
 +
 +  * //We may also add archive//
 ===== Generating an API Key ===== ===== Generating an API Key =====
  
-  - Navigate to the Admin panel +  - Navigate to the **Admin** panel 
-  - Click on API +  - Click on **API** 
-  - Click on New Key to generate a new key+  - Click on **New Key** to generate a new key 
 +  - Select whether the key will have access limited to a specific client, or have access to data for all clients
  
  
Line 45: Line 51:
 ==== 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 ''limit'' and ''offset'' parameters. 
-  * For POST requests, the client_id parameter is always required if the API key used has scope/access to all clients+  * For POST requests, the ''client_id'' parameter is always required if the API key used has scope/access to all clients 
 +  * Be sure to check your Apache/PHP error logs if you're running into issues
  
 ==== API Docs/Examples ==== ==== API Docs/Examples ====
  
-Documentation / an example of how to use a module API endpoint is shown on that module's doc page. Additional examples are available here. +Documentation / an example of how to use a module API endpoint is shown on that module's doc page. Additional examples are available [[https://github.com/itflow-org/itflow-api-powershell|here]].
- +
- +
-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's name thats calling in) - /api.php?api_key=[API_KEY]&cid=[PHONE_NUMBER] - Returns a name 
-  *     XML Phonebook Download - /api.php?api_key=[API_KEY]&phonebook 
-  *     Client Email (great for mailing lists) - /api.php?api_key=[API_KEY]&client_emails - Returns Client Name - Email Address 
-  *     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) - /api.php?api_key=[API_KEY]&client_id=[CLIENT_ID] - Returns Account Balance 
-  *     Add new asset for a client - /api.php?api_key=[API_KEY]&client_id=ClientID&add_asset=Name&type=[Desktop|Laptop|Server]&make=Make&model=Model&serial=Serial&os=OS 
-  *         Required: api_key, client_id, add_asset (name)