Dokumentation för API-funktioner
GET CRM/Lead/{customerId}/Incoming/{id} Hämtar uppgifter om ett inkommande lead, dvs ett lead som skickats till mäklarsystemet från en extern aktör Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kundid string Krävs
id Id för leadet string Krävs
Response Information Resource Description Hämtar uppgifter om ett inkommande lead, dvs ett lead som skickats till mäklarsystemet från en extern aktör IncomingLead
NamnBeskrivningTypInformation
ContactId Id på kontakten som leadet avser. Är angiven om kontaktpersonen fortfarande finns kvar i mäklarsystemet. string

LeadSource Källa till leadet, dvs en förklaring till hur leadet kom in i mäklarsystemet. LeadSource

SentAt Datum och tidpunkt då leadet skickades. date

Receiver Mottagare av leadet, dvs den handläggare, den grupp eller det kontor som för närvarande är ansvarig för leadet. LeadReceiver

BuyingEstateId Id för eventuell bostad som kontaktpersonen är spekulant på. string

SellingEstateId Id för eventuell bostad som kontaktpersonen vill sälja. string

State Aktuell status för leadet State

Message Anteckning för leadet. Kan anges både när leadet skickas och när mottagaren arbetar med leadet. string

IsAnonymized Anger om leadet är anonymiserat, dvs om det inte längre finns någon kontaktperson kopplat till leadet eftersom denne pga GDPR-regler eller annan orsak blivit borttagen från systemet. boolean

UtmTags UTM taggar för sidan där leadet skapades Collection of FormMarketingUtmTags

Kodexempel

curl "https://connect.maklare.vitec.net/CRM/Lead/StringValue/Incoming/StringValue" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" 
            

$URL = "https://connect.maklare.vitec.net/CRM/Lead/StringValue/Incoming/StringValue"
Invoke-WebRequest -Uri $URL -Method GET -Headers @{"authorization" = "basic {Base64 kodad användarnamn och lösenord}"} 
                

// 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}")
//     }
// }
using (var response = await HttpClientInstance.GetAsync("CRM/Lead/StringValue/Incoming/StringValue")) {
    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);
    
    var contactId = result.contactId.Value;
    // TODO: Gör något med resultatet
}

$URL = "https://connect.maklare.vitec.net/CRM/Lead/StringValue/Incoming/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);

$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
}

$field_on_result = $result["contactId"];
// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
{
  "contactId": "sample string 1",
  "leadSource": {
    "id": "sample string 1",
    "name": "sample string 2",
    "leadType": "AcceptObjectFlow"
  },
  "sentAt": "2024-05-06T07:31:58.2272847+02:00",
  "receiver": {
    "agent": {
      "id": "sample string 1",
      "office": {
        "id": "sample string 1",
        "customerId": "sample string 2"
      }
    },
    "userGroup": {
      "id": "sample string 1"
    },
    "office": {
      "id": "sample string 1",
      "customerId": "sample string 2"
    }
  },
  "buyingEstateId": "sample string 3",
  "sellingEstateId": "sample string 4",
  "state": "New",
  "message": "sample string 5",
  "isAnonymized": true,
  "utmTags": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ]
}
<IncomingLead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Lead.ExistingLead">
  <BuyingEstateId>sample string 3</BuyingEstateId>
  <ContactId>sample string 1</ContactId>
  <IsAnonymized>true</IsAnonymized>
  <LeadSource>
    <Id>sample string 1</Id>
    <LeadType>AcceptObjectFlow</LeadType>
    <Name>sample string 2</Name>
  </LeadSource>
  <Message>sample string 5</Message>
  <Receiver>
    <Agent>
      <Id>sample string 1</Id>
      <Office>
        <CustomerId>sample string 2</CustomerId>
        <Id>sample string 1</Id>
      </Office>
    </Agent>
    <Office>
      <CustomerId>sample string 2</CustomerId>
      <Id>sample string 1</Id>
    </Office>
    <UserGroup>
      <Id>sample string 1</Id>
    </UserGroup>
  </Receiver>
  <SellingEstateId>sample string 4</SellingEstateId>
  <SentAt>2024-05-06T07:31:58.2272847+02:00</SentAt>
  <State>New</State>
  <UtmTags xmlns:d2p1="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Services.Advertising">
    <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>
  </UtmTags>
</IncomingLead>