© 2015 X2Engine Inc.

Difference between revisions of "Web API Reference (Legacy)"

From X2Engine
Jump to: navigation, search
(→‎Attribute Input Format)
(→‎Miscellaneous API actions =)
Line 110: Line 110:
 
The input to the API will be processed in the same way that it is within the application, that is to say, using the method [[x2propdoc:X2Model.html#_setX2Fields|X2Model.setX2Fields()]]. In particular, the method [[x2propdoc:Fields.html#_parseValue|Fields.parseValue()]] is used for processing and transforming the data before it is recorded in the database. The <tt>case</tt> statement in that method shows how each type of field is processed (see [[X2Model_and_Dynamic_Fields|X2Model and Dynamic Fields]] for more information on field types and how fields are dynamically managed)
 
The input to the API will be processed in the same way that it is within the application, that is to say, using the method [[x2propdoc:X2Model.html#_setX2Fields|X2Model.setX2Fields()]]. In particular, the method [[x2propdoc:Fields.html#_parseValue|Fields.parseValue()]] is used for processing and transforming the data before it is recorded in the database. The <tt>case</tt> statement in that method shows how each type of field is processed (see [[X2Model_and_Dynamic_Fields|X2Model and Dynamic Fields]] for more information on field types and how fields are dynamically managed)
  
−
= Miscellaneous API actions ==
+
= Miscellaneous API actions =
−
(See also the documentation on [[x2doc:ApiController|ApiController]])
 
−
 
 
−
The methods of [[x2doc:ApiController|ApiController]] used for creating, querying, viewing (by ID), updating and deleting records are:
 
  
 +
== Create a relationship between two records ==
 +
One can create, get lists of and delete relationships between records in X2CRM by using the [[x2propdoc:ApiController.html#_actionRelationship|actionRelationship()]] method. Of all the API methods, this is one of the most recently-created; creation, retrieval and deletion of relationships all happen through the same URL. This is an effort to shift in the direction of an ultimately more REST-ful and clean API. The following table describes its uses and responses:
 
{|class="wikitable" align="center"
 
{|class="wikitable" align="center"
 
|-
 
|-
−
! scope="col" | Method
+
! scope="col" | Use
−
! scope="col" | Base URL
+
! scope="col" | Request Type / Data
−
! scope="col" | ID required
+
! scope="col" | Codes
−
! scope="col" | Usage
+
! scope="col" | Response
 
|-
 
|-
−
|[[x2propdoc:ApiController.html#_actionCreate|actionCreate()]]
+
|
−
|<tt>index.php/api/create</tt>
+
|
−
|no
+
|
−
|Creates a new record
+
|
 
|-
 
|-
−
|[[x2propdoc:ApiController.html#_actionLookup|actionLookup()]]
+
|}
−
|<tt>index.php/api/lookup</tt>
+
 
−
|no
+
 
−
|Searches for a record based on one or more fields
+
 
 +
[[x2propdoc:ApiController.html#_actionVoip|actionVoip()]]
 +
 
 +
 
 +
{|class="wikitable" align="center"
 
|-
 
|-
−
|[[x2propdoc:ApiController.html#_actionView|actionView()]]
+
! scope="col" | Use
−
|<tt>index.php/api/view</tt>
+
! scope="col" | Method
−
|yes
+
! scope="col" | Authentication
−
|Views a record
+
! scope="col" | Relative URL
−
|-
+
! scope="col" | Notes
−
|[[x2propdoc:ApiController.html#_actionUpdate|actionUpdate()]]
 
−
|<tt>index.php/api/update</tt>
 
−
|yes
 
−
|Updates a record
 
−
|-
 
−
|[[x2propdoc:ApiController.html#_actionDelete|actionDelete()]]
 
−
|<tt>index.php/api/delete</tt>
 
−
|yes
 
−
|Deletes a record
 
 
|-
 
|-
 +
|Make note of a VoIP call
 
|[[x2propdoc:ApiController.html#_actionVoip|actionVoip()]]
 
|[[x2propdoc:ApiController.html#_actionVoip|actionVoip()]]
−
|<tt>index.php/api/voip</tt>
+
|/voip
 
|no
 
|no
 
|Notifies the assignee of a contact having called (if the phone number matches).<br> Requires only the "phone" field, as a GET parameter, it being a 10+ digit phone number.
 
|Notifies the assignee of a contact having called (if the phone number matches).<br> Requires only the "phone" field, as a GET parameter, it being a 10+ digit phone number.
 +
|-
 +
|Get a list of all users in the app
 +
|/listUsers
 +
|[[x2propdoc:ApiController.html#_actionListUsers|actionListUsers()]]
 +
|yes
 +
|/listUsers
 +
|Will return with HTTP code 403 if the user used for authenticating does not have permission to the UsersIndex RBAC action.
 
|-
 
|-
 
|}
 
|}

Revision as of 00:14, 7 September 2013


X2CRM features a remote API for inserting, updating, querying and deleting records via ApiController, which (with few exceptions) responds in JSON format. The API can perform these operations with any subclass of X2Model. URLs (after the domain name and relative path to the document root) for web requests to the API begin with index.php/api/.

Authenticating

In most calls to the API, authentication is required in the form of GET or POST parameters user and userKey, which are the username and API key (respectively) of a user in the CRM. In versions earlier than 2.9.1, these parameters are named authUser and authPassword, and authPassword is the password hash. A user's API key can be set by the administrator in the User module by visiting the update page for the given user.

CRUD (Create, Read, Update & Delete) API Methods

The following API actions can be used with any subclass of X2Model (i.e. Contacts, Accounts, Opportunity, etc.) In the following reference table, the model class to be used for display purposes is Contacts, and the id (primary key) value is 5.

Use Method URL Authentication Request type/data expected Code Response properties
Create a new record actionCreate() /create/model/Contacts With post data POST; authentication & model attributes together in a flat list as URL-encoded form data
200
Record successfully inserted
500
Model failed validation
error
true if and only if the new record was created successfully
model
attributes of the model as key-value pairs (indexed by attribute name)
modelErrors
validation errors for each attribute, if applicable
Search for the first record matching one or more fields actionLookup() /lookup/model/Contacts With post data POST; Same as with the create action
200
found record
404
no record found
 If successful: attributes of the model as a flat key-value pair list (indexed by attribute name). Otherwise:
error
boolean / true
message
"No item found with specified attributes."
Retrieve a record by primary key actionView() /view/Contacts/id/5 As additional query parameters appended to the URL GET
200
Record found with specified primary key
400
The primary key is not included properly or specified
404
No record found
 Attributes of the model as a flat list indexed by attribute name, if successful. Otherwise:
error
boolean / true, indicating an error
message
A string containing an explanation of what went wrong
Update a preexisting record actionUpdate() /update/model/Contacts/id/5 With post data POST; same as with create method
200
Record successfully updated
404
Record to be updated does not exist
400
Primary key is missing from query parameters
500
Model failed validation during update
 Same as with create action
Delete a record actionDelete() /delete/model/Contacts/id/5 With post data POST; authentication data
200
Record successfully deleted
404
Record to be deleted does not exist
400
Primary key is missing from query parameters
500
Record could not be deleted
message
"1" if successful; else, an error message
error
boolean / true if and only if successful

Attribute Input Format

The input to the API will be processed in the same way that it is within the application, that is to say, using the method X2Model.setX2Fields(). In particular, the method Fields.parseValue() is used for processing and transforming the data before it is recorded in the database. The case statement in that method shows how each type of field is processed (see X2Model and Dynamic Fields for more information on field types and how fields are dynamically managed)

Miscellaneous API actions

Create a relationship between two records

One can create, get lists of and delete relationships between records in X2CRM by using the actionRelationship() method. Of all the API methods, this is one of the most recently-created; creation, retrieval and deletion of relationships all happen through the same URL. This is an effort to shift in the direction of an ultimately more REST-ful and clean API. The following table describes its uses and responses:

Use Request Type / Data Codes Response


actionVoip()


Use Method Authentication Relative URL Notes
Make note of a VoIP call actionVoip() /voip no Notifies the assignee of a contact having called (if the phone number matches).
Requires only the "phone" field, as a GET parameter, it being a 10+ digit phone number.
Get a list of all users in the app /listUsers actionListUsers() yes /listUsers Will return with HTTP code 403 if the user used for authenticating does not have permission to the UsersIndex RBAC action.

Specifying Model

The API requires specifying the model for which the transaction will be performed as a GET parameter with key "model", with actionVoip being the only current exception. Per the URL format rule of X2CRM, which is "path" (see CUrlManager for more information), the full URL of the request will be: index.php/api/[method]/model/[model name]. So, for example, an API call to create a new contact record should use index.php/api/create/model/Contacts

Usage Example

The file leadCapture.php in the web root of the codebase contains a few noteworthy examples of API calls. Of particular significance is the necessity of creating a contact first and then using lookup to obtain its numeric ID in order to create an action associated with that contact.

(section in progress)

Retrieved from "http://wiki.x2crm.com/index.php?title=Web_API_Reference_(Legacy)&oldid=1050"