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 [2024/02/10 12:14] – add clients wrongechoapi [2024/08/29 22:50] (current) – [Generating an API Key] Mention all clients/specific wrongecho
Line 12: Line 12:
   * clients   * clients
   * contacts   * contacts
 +  * credentials (logins)
   * domains   * domains
   * networks   * networks
Line 23: Line 24:
   * create //(partial)//   * create //(partial)//
   * update //(partial)//   * update //(partial)//
 +  * delete //(partial)//
 +
 +
 +  * //We may also add archive//
 ===== Generating an API Key ===== ===== Generating an API Key =====
  
Line 28: Line 33:
   - 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   * Be sure to check your Apache/PHP error logs if you're running into issues