MyCRM APIs
Request Format
HTTP - GET / POST
application/x-www-form-urlencoded
Response Format
Success
{ success: true, result: {
....
} }
Failure
{ success: false, error: { message: String, code: String } }
Login Operation
Its a two-step process that involves getting the challenge token and exchanging the credentials (username and accessKey). You can find accessKey information under “My Preferences” in the CRM Web UI.
Challenge
GET /webservice.php?operation=getchallenge&username=<USERNAME> HTTP/1.1
Challenge Response
{ success: true, result: {
token: TOKENSTRING, // Challenge token to be used for login.
serverTime: TOKENSTRING, // Current Server time
expireTime: TIMESTAMP // Time when token expires
} }
Login
POST /webservice.php HTTP/1.1
operation=login username=<USERNAME> accessKey=md5(TOKENSTRING + <ACCESSKEY>) // Note: accessKey= K here is capitalized
Login Response
{ success: true, result: {
sessionId:String,// Unique Identifier for the session
userId:String,// User ID in CRM
version: String, // Webservice API version
} }
Create Operation
POST /webservice.php HTTP/1.1
operation=create
sessionName=sessionId // Obtained through Login Operation
element=URLENCODED(JSONDATA) // JSONDATA - JSON Map of (fieldname=fieldvalue)
elementType=<TYPE> // TYPE - Module Name
Update Operation
POST /webservice.php HTTP/1.1
operation=update
sessionName=sessionId // Obtained through Login Operation
element=URLENCODED(DATA) // DATA - Map of (fieldname=fieldvalue)
Extend Session Operation
GET /webservice.php?operation=extendsession&sessionName=<sessionID> HTTP/1.1
Validate Address Service Availability
GET https://prefav2.mycrmllc.com/fcc?address=URLENCODED(address city, state) HTTP/1.1
Validate Address Response
{
"data": [
{
"coordinates": [
latitud,
longitud
],
"unitCount": 99 ,
"buildingTypeCode": "B",
"bsl_flag": true,
"license": "Fabric location data provided by CostQuest Associates, Inc., all rights reserved. Use of these data are restricted. Unauthorized access to the Fabric, including scripted or programmatic access, is strictly prohibited and may be subject to criminal and civil penalties, including, but not limited to, penalties applicable to knowingly or intentionally accessing a computer without authorization or exceeding authorized access under 18 U.S.C. § 1030 and circumvention of technological measures under 17 U.S.C. § 1201.",
"detail": [
{
"location_id": 999999999 ,
"provider_name": " BellSouth Telecommunications, LLC ",
"brand_name": " AT&T Inc ",
"technology_code": "10",
"bizrescode": "X",
"maxdown": 10,
"maxup": 1,
"lowlatency": 1,
"frn": "999999999",
"provider_id": "999999999",
"holding_company_name": " AT&T Inc. ",
"technology_code_type": " Copper ",
"prov_tech_flag": false
},{
"location_id": 999999999,
"provider_name": "COMCAST CABLE COMMUNICATIONS, LLC",
"brand_name": "Xfinity",
"technology_code": "10",
"bizrescode": "X",
"maxdown": 10,
"maxup": 1,
"lowlatency": 1,
"frn": "999999999",
"provider_id": "999999999",
"holding_company_name": "Comcast Corporation",
"technology_code_type": "Cable",
"prov_tech_flag": false
},
{
"location_id": 999999999,
"provider_name": "Crown Castle Fiber LLC",
"brand_name": " Crown Castle Fiber LLC ",
"technology_code": "40",
"bizrescode": "X",
"maxdown": 1200,
"maxup": 35,
"lowlatency": 1,
"frn": "0003768165",
"provider_id": "130317",
"holding_company_name": "Crown Castle Inc",
"technology_code_type": "Fiber to the Premises",
"prov_tech_flag": false
},
]
}
],
"result_count": 1,
"status_code": 200,
"message": null,
"status": " successful ",
"request_date": "9999-99-99T16:42:21.481Z"
}
Entities
Leads
Fieldname | Description | Required |
firstname |
|
* |
lastname |
|
*
|
phone |
|
|
mobile | ||
leadsource | ||
business_name | ||
assigned_user_id |
|
* |
lane | ||
code | ||
pobox | ||
state | ||
city | ||
zip4 | ||
apart | ||
description | ||
utm_source | ||
utm_medium | ||
utm_campaign | ||
utm_content | ||
utm_term |
Contacts
Fieldname | Description | Required |
firstname |
|
* |
lastname |
|
*
|
phone |
|
|
mobile | ||
homephone | ||
leadsource | ||
birthday | ||
business_name | ||
assigned_user_id |
|
* |
is_customer | ||
mailingstreet | ||
mailingpobox | ||
mailingstate | ||
mailingcity | ||
mailingzip | ||
apart | ||
zip4 | ||
description | ||
pager | ||
csg_number | ||
spouse_name | ||
ssn | ||
service_dt | ||
dl_license | ||
dl_state | ||
dl_expdate | ||
utm_source | ||
utm_medium | ||
utm_campaign | ||
utm_content | ||
utm_term |