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 [2026/04/11 21:49] – 68.162.129.20api [2026/09/10 16:47] (current) – link to developer.itflow.org wrongecho
Line 1: Line 1:
 ====== API ====== ====== API ======
  
- +Use ITFlow's API to work with ITFlow in scripts and third-party applications.
-Use ITFlow's API to work with ITFlow in scripts third-party applications.+
  
 The current version of the ITFlow API is v1. It can be accessed at **itflow.example.com/api/v1/{module}/{function}.php** The current version of the ITFlow API is v1. It can be accessed at **itflow.example.com/api/v1/{module}/{function}.php**
  
-===== Generating an API Key ===== +We are in the process of creating dedicated API documentation accessible at: [[https://developer.itflow.org]]
- +
-  - Login and navigate to the **Admin Settings** page +
-  - Select **API Keys** +
-  - Select **Create** to open the New Key modal +
-  - On Details tab, input the key name and expiration date. Select whether the key will allow access to all clients or a specific client +
-  - On Keys tab, note down the API key and credential password and select the checkbox to confirm you've made a copy of the keys. You will not see these admin in the admin interface. +
-  - Select Create to add the key into the database +
- +
-===== Modules with API support at present ===== +
- +
-  * assets +
-  * certificates +
-  * clients +
-  * contacts +
-  * credentials (logins) +
-  * documents +
-  * domains +
-  * expenses +
-  * invoices +
-  * invoice_items +
-  * locations +
-  * networks +
-  * payments +
-  * products +
-  * quotes +
-  * software +
-  * tickets +
-  * vendors +
- +
- +
-===== API Functions ===== +
- +
-  * read +
-  * create //(partial)// +
-  * update //(partial)// +
-  * delete //(partial)// +
- +
- +
-  * //We may also add archive// +
- +
-===== Request Methods ===== +
- +
-  * GET - Retrieving (READ) data +
-  * POST - Inserting (CREATE), Updating (UPDATE) or Deleting (DELETE) data +
- +
-==== Data Returned ==== +
- +
-  * Success - True/False +
-  * Message - Failure info / Helpful debug info +
-  * Count - Count of rows affected/returned +
-  * Data - The data requested/created/changed +
- +
- +
-==== Notes ==== +
- +
-  * 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 +
-  * Be sure to check your Apache/PHP error logs if you're running into issues +
- +
-==== 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 [[https://github.com/itflow-org/itflow-api-powershell|here]]. +
- +
- +
- +
----- +
- +
- +
-====== API ====== +
- +
-Use ITFlow's API to work with ITFlow in scripts and third-party applications. +
- +
-The current version of the ITFlow API is v1. It can be accessed at **itflow.example.com/api/v1/{module}/{function}.php**+
  
 ===== Generating an API Key ===== ===== Generating an API Key =====
Line 138: Line 64:
   * 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   * Be sure to check your Apache/PHP error logs if you're running into issues
 +  * To prevent your server from accidentally logging API keys, see [[api_apache-logging|here]]
  
 ---- ----