הצגת המקור של הדף "ממשקי API"


=CRM API Documentation=
This documentation covers the core CRM endpoints: ''get_data.php'', ''set_data.php'', and ''set_status.php''.
----
==1) <code>get_data.php - by phone</code>==
;Purpose
Retrieve customer or repository data by DID and phone number.
;Method
<code>GET</code>
;Authorization Required
Yes (<code>authkey</code>): Mindc_2023_get_data
===Parameters===
{| class="wikitable"
!Parameter!!Required!!Description
|-
|<code>authkey</code>||✅||Authentication key: Mindc_2023_get_data
|-
|<code>did</code>||✅||Incoming DID number
|-
|<code>phone</code>||✅||Customer phone number
|-
|<code>out</code>||✅||Comma-separated list of output fields
|-
|<code>project_id</code>||⚠️*||Project ID
|-
|<code>worker_id</code>||⚠️*||Worker ID (used to resolve project)
|-
|<code>group_id</code>||❌||Filter by group
|-
|<code>repository_id</code>||❌||Filter by repository
|-
|<code>site_id</code>||❌||Filter by site
|}''⚠️ At least one of <code>project_id</code> or <code>worker_id</code> is required.''
===Special <code>out</code> Fields===
You may request the following:
*<code>last_status</code>
*<code>last_call</code>
*<code>last_notes</code>
*<code>repository_id</code>
*<code>repository_name</code>
*<code>repository_assign_id</code>
*Any customer field from the Forms module
===Example Requests===
<pre>
GET /api/get_data.php?authkey=Mindc_2023_get_data&did=07333333333&phone=0500000000&project_id=10&out=first_name,last_status,repository_name
</pre><pre>
GET /api/get_data.php?authkey=Mindc_2023_get_data&repository_assign_id=2190811&out=uid,repository_name,customer_name
</pre>
===Success Response===
<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": [
    {
      "uid": "123",
      "name": "John Doe",
      "email": "john@mail.com",
      "last_status": "Interested"
    }
  ]
}
</syntaxhighlight>Or empty results:<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": []
}
</syntaxhighlight>
===Failure Response===
<syntaxhighlight lang="json">
{
  "code": 3,
  "status": "fail",
  "message": "Missing phone"
}
</syntaxhighlight>
===Error Codes===
{| class="wikitable"
!Code!!Meaning
|-
|1||Missing or invalid authkey
|-
|2||Missing DID
|-
|3||Missing phone
|-
|4||Missing <code>out</code> parameter
|-
|5||Missing both project_id and worker_id
|-
|6||No matching repository assign
|-
|7||Database exception
|}
----

== 2) <code>get_data.php - by phone</code> ==
;Purpose
Retrieve customer or repository data by repository_assign_id value
;Method
<code>GET</code>
;Authorization Required
Yes (<code>authkey</code>): Mindc_2023_get_data
===Parameters===
{| class="wikitable"
!Parameter!!Required!!Description
|-
|<code>authkey</code>||✅||Authentication key: Mindc_2023_get_data
|-
|<code>repository_id</code>||✅||Filter by repository
|-
|<code>out</code>||✅||Comma-separated list of output fields
|-
|<code>project_id</code>||⚠️*||Project ID
|-
|<code>worker_id</code>||⚠️*||Worker ID (used to resolve project)
|-
|<code>group_id</code>||❌||Filter by group
|-
|<code>site_id</code>||❌||Filter by site
|}
===Special <code>out</code> Fields===
You may request the following:
*<code>last_status</code>
*<code>last_call</code>
*<code>last_notes</code>
*<code>repository_id</code>
*<code>repository_name</code>
*<code>repository_assign_id</code>
*Any customer field from the Forms module
===Example Requests===
<pre>
GET /api/get_data.php?authkey=Mindc_2023_get_data&repository_assign_id=2190811&out=uid,repository_name,customer_name
</pre>
===Success Response===
<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": [
    {
      "uid": "123",
      "name": "John Doe",
      "email": "john@mail.com",
      "last_status": "Interested"
    }
  ]
}
</syntaxhighlight>Or empty results:<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": []
}
</syntaxhighlight>
===Failure Response===
<syntaxhighlight lang="json">
{
  "code": 3,
  "status": "fail",
  "message": "Missing phone"
}
</syntaxhighlight>
===Error Codes===
{| class="wikitable"
!Code!!Meaning
|-
|1||Missing or invalid authkey
|-
|2||Missing DID
|-
|3||Missing phone
|-
|4||Missing <code>out</code> parameter
|-
|5||Missing both project_id and worker_id
|-
|6||No matching repository assign
|-
|7||Database exception
|}
==3) <code>set_data.php</code>==
;Purpose
Update customer fields and/or status.
;Method
<code>GET</code> or <code>POST</code>
;Authorization Required
Yes (<code>authkey</code>): Mindc_2023_set_data
===Parameters===
{| class="wikitable"
!Parameter!!Required!!Description
|-
|<code>authkey</code>||✅||Authentication key: Mindc_2023_set_data
|-
|<code>repository_assign_id</code>||⚠️*||Direct repository assign ID
|-
|<code>project_id</code>||⚠️*||Project ID (used if <code>repository_assign_id</code> not provided)
|-
|<code>worker_id</code>||⚠️*||Worker ID (used if <code>repository_assign_id</code> not provided)
|-
|<code>phone</code>||⚠️**||Customer phone (required if not using <code>repository_assign_id</code>)
|-
|<code>did</code>||⚠️**||DID number (required if not using <code>repository_assign_id</code>)
|-
|<code>group_id</code>||❌||Filter for lookup
|-
|<code>repository_id</code>||❌||Filter for lookup
|-
|<code>site_id</code>||❌||Filter for lookup
|-
|<code>status_id</code>||❌||Status ID to set
|-
|Any field name||❌||Any valid customer field (use <code>display_name</code>)
|}''⚠️ Either <code>repository_assign_id</code> OR (<code>project_id</code> + <code>worker_id</code> + <code>phone</code> + <code>did</code>) is required.''  

''⚠️ <code>phone</code> and <code>did</code> are required if not using <code>repository_assign_id</code>.''

=== Example Requests ===

==== Update Customer Data (Using repository_assign_id) ====
 POST /dev-6/api/set_data.php | authkey=Mindc_2023_set_data&repository_assign_id=555&first_name=Jane&email=jane@example.com

 Content-Type: application/x-www-form-urlencoded

==== Update Status Only (Using Phone & Project Context) ====
 GET /dev-6/api/set_data.php?authkey=Mindc_2023_set_data&did=123456&phone=972500000000&project_id=15&status_id=10

=== Update Data and Status Together (with worker_id) ===
 POST /dev-6/api/set_data.php | authkey=Mindc_2023_set_data&repository_assign_id=555&city=New York&status_id=2&worker_id=99

===Success Responses===
;Fields Updated
<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": "email was updated to 'a@mail.com', name was updated to 'Anna'"
}
</syntaxhighlight>
;Only Status Updated
<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": "Status set successfully"
}
</syntaxhighlight>
;Partial Success
<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": "Fields updated",
  "errors": {
    "status": "Failed to set status"
  }
}
</syntaxhighlight>
===Error Codes===
{| class="wikitable"
!Code!!Meaning
|-
|1||Missing or invalid authkey
|-
|2||Missing repository assign ID
|-
|3||Invalid repository assign ID
|-
|4||Duplicate unique field
|-
|5||Update failed
|-
|6||No valid fields or repository not found
|-
|7||No fields provided in request
|}
----
==4) <code>set_status.php</code>==
;Purpose
Set or clear customer status for a repository assign.
;Method
<code>GET</code> or <code>POST</code>
;Authorization Required
Yes (<code>authkey</code>): Mindc_2023_set_status
===Parameters===
{| class="wikitable"
!Parameter!!Required!!Description
|-
|<code>authkey</code>||✅||Authentication key: Mindc_2023_set_status
|-
|<code>repository_assign_id</code>||✅||Repository assign ID
|-
|<code>status_id</code>||✅||Status ID (or <code>0</code> = clear status)
|-
|<code>worker_id</code>||❌||Worker ID (for audit purposes)
|}

=== Example Requests ===

==== Set Status for a Customer ====
 GET /dev-6/api/set_status.php?authkey=Mindc_2023_set_status&repository_assign_id=555&status_id=10

=== Clear Status ===
 POST /dev-6/api/set_status.php | authkey=Mindc_2023_set_status&repository_assign_id=555&status_id=0

 Content-Type: application/x-www-form-urlencoded

===Success Response===
<syntaxhighlight lang="json">
{
  "code": 0,
  "status": "success",
  "message": "Status set successfully"
}
</syntaxhighlight>
===Error Codes===
{| class="wikitable"
!Code!!Meaning
|-
|1||Missing or invalid authkey
|-
|2||Missing repository assign ID
|-
|3||Invalid repository assign ID
|-
|4||Missing status ID
|-
|5||Failed to set status
|}