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
clients [2023/04/29 03:28] – link to aad sso wrongechoclients [2024/02/10 07:13] (current) – add client read api example wrongecho
Line 1: Line 1:
 ====== Clients ====== ====== Clients ======
  
-Each customer that you provide IT services for is considered to be a client within ITFlow. +Each customer that you provide IT services for is considered to be a client within ITFlow. This is the first order of business in creating and populating your clients into your ITFlow installation. 
 + 
 +**Instructions in creating your first client record** 
 +  - From the sidebar, select "Client Management". 
 +  - In the "Client Management" screen, click on the "+ New Client" button on the top right. 
 +  - A pop up window will appear with 5 tabs. Do fill the fields up accordingly. 
 +  - Do note that the "Location" and "Contact" tabs will be used to create a separate Location and Contact; after creating the Client record, you have to edit the Location and Contact details separately within the Client record itself as they cannot be edited in the Client Edit (3 button) pop-up screen.
  
 {{::clients.png?600|}} {{::clients.png?600|}}
Line 25: Line 31:
  
 For more details on client portal authentication, see [[aad_sso|Client Portal - Azure AD SSO]]. For more details on client portal authentication, see [[aad_sso|Client Portal - Azure AD SSO]].
 +
 +
 +----
 +
  
 ===== API ===== ===== API =====
 ''/api/v1/clients'' ''/api/v1/clients''
 +
 +==== Read ====
 +Retrieve client information - ''/read.php''.
 +
 +  * Default / No params - Returns all clients
 +  * client_id - Specific client ID from the ITFlow database
 +  * client_name - Lookup by client name
 +
 +  Invoke-RestMethod -Uri "https://demo.itflow.org/api/v1/clients/read.php?api_key=YOUR-API-KEY&client_id=111" | ConvertTo-Json
 +  
 +  {
 +    "success":  "True",
 +    "count":  1,
 +    "data":  [
 +                 {
 +                     "0":  "111",
 +                     "client_id":  "111",
 +                     "1":  "0",
 +                     "client_lead":  "0",
 +                     "2":  "Let it burn Inc",
 +                     "client_name":  "Let it burn Inc",
 +                     "3":  "Safety and Fire",
 +                     "client_type":  "Safety and Fire",
 +                     "4":  "",
 +                     "client_website":  "example.com",
 +  [...]