Vitec Connect
Dokumentation för API-funktioner
POST CRM/Lead/{customerId} Skapar ett lead Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kundid string Krävs
Body Parameters Lead Lead
NamnBeskrivningTypInformation
ContactId Id på leads kontakten string Required
AssignedToId Id på den användare, användargrupp eller kontor som leadet skickas till string Required
OfficeId Id på användarens kontor (om leadet skickas till en användare) string

AssignmentSourceId Intagskälla string

LeadSourceId Id på leadskällan string Required
Marketing Marknadsföringsuppgifter som t ex UTM taggar FormMarketing

Message Meddelande string

Request Formats

{
  "contactId": "sample string 1",
  "assignedToId": "sample string 2",
  "officeId": "sample string 3",
  "assignmentSourceId": "sample string 4",
  "leadSourceId": "sample string 5",
  "marketing": {
    "referrer": "sample string 1",
    "utmTags": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ]
  },
  "message": "sample string 6"
}

<Lead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Lead">
  <AssignedToId>sample string 2</AssignedToId>
  <AssignmentSourceId>sample string 4</AssignmentSourceId>
  <ContactId>sample string 1</ContactId>
  <LeadSourceId>sample string 5</LeadSourceId>
  <Marketing xmlns:d2p1="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Services.Advertising">
    <d2p1:Referrer>sample string 1</d2p1:Referrer>
    <d2p1:UtmTags>
      <d2p1:FormMarketingUtmTags>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:FormMarketingUtmTags>
      <d2p1:FormMarketingUtmTags>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:FormMarketingUtmTags>
    </d2p1:UtmTags>
  </Marketing>
  <Message>sample string 6</Message>
  <OfficeId>sample string 3</OfficeId>
</Lead>
Response Information Resource Description Skapar ett lead string Kodexempel 

curl "https://connect.maklare.vitec.net/CRM/Lead/StringValue" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"contactId\":\"StringValue\",\"assignedToId\":\"StringValue\",\"officeId\":\"StringValue\"}
            

$URL = "https://connect.maklare.vitec.net/CRM/Lead/StringValue"
$data = "{`"contactId`":`"StringValue`",`"assignedToId`":`"StringValue`",`"officeId`":`"StringValue`"}"
Invoke-WebRequest -Uri $URL -Method POST -Headers @{"Content-Type" = "application/json"; "authorization" = "basic {Base64 kodad användarnamn och lösenord}"} -Body $data
                

// HttpClientInstance ska deklareras som en singleton
// public static readonly HttpClient HttpClientInstance = new HttpClient {
//     BaseAddress = new Uri("https://connect.maklare.vitec.net"),
//     DefaultRequestHeaders = {
//         Authorization = new AuthenticationHeaderValue("Basic", "{Base64 kodad användarnamn och lösenord}")
//     }
// }
var json = "{\"contactId\":\"StringValue\",\"assignedToId\":\"StringValue\",\"officeId\":\"StringValue\"}";
using (var response = await HttpClientInstance.PostAsync("CRM/Lead/StringValue", new StringContent(json, Encoding.UTF8, "application/json"))) {
    if (response.StatusCode == HttpStatusCode.Unauthorized) {
        // Authorization headern är inte korrekt
    }
    if (response.StatusCode == HttpStatusCode.Forbidden) {
        // Begärt data som det saknas åtkomst till
    }
    if (response.StatusCode == HttpStatusCode.InternalServerError) {
        // Oväntat fel, kontakta Vitec
    }
    if (response.StatusCode == HttpStatusCode.BadRequest) {
        var json = await response.Content.ReadAsStringAsync();
        var result = JsonConvert.DeserializeObject<dynamic>(json);
        // Hantera valideringsfel, presenteras i resultatet
    }
    
    var json = await response.Content.ReadAsStringAsync();
    // JsonConvert finns i biblioteket Newtonsoft.Json
    var result = JsonConvert.DeserializeObject<dynamic>(json);
    
    // TODO: Gör något med resultatet
}


$URL = "https://connect.maklare.vitec.net/CRM/Lead/StringValue";

$ch = curl_init();

curl_setopt($ch, CURLOPT_USERNAME, "{Användarnamn}");
curl_setopt($ch, CURLOPT_PASSWORD, "{Lösenord}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $URL);
$data = "{\"contactId\":\"StringValue\",\"assignedToId\":\"StringValue\",\"officeId\":\"StringValue\"}";
curl_setopt($ch, CURLOPT_POST, true);

curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data)
));

$result = curl_exec($ch);

if (curl_errno($ch)) {
    die(curl_getinfo($ch));
}

$info = curl_getinfo($ch);
curl_close($ch);

$http_code = $info["http_code"];
if ($http_code == 401) {
    // Användarnamnet eller lösenordet är felaktigt
}
if ($http_code == 403) {
    // Begärt data som det saknas åtkomst till
}
if ($http_code == 500) {
    // Oväntat fel, kontakta Vitec
}
if ($http_code == 400) {
    $json = json_decode($result, true);
    // Hantera valideringsfel, presenteras i $json
}

// TODO: Gör något med resultatet
Testformulär Text input
Response Formats 
"sample string 1"

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>