Dokumentation för API-funktioner
GET PublicAdvertising/Office/{customerId}/{officeId} För att kunna hämta företagen så krävs det en giltig API nyckel och ett kundid. Request Information URI Parameters
NamnBeskrivningTypInformation
customerId string Krävs
officeId string Krävs
Response Information Resource Description Hämtar företag. Hämtar information om mäklarkontoret. Office
NamnBeskrivningTypInformation
Id Id string

CustomerId Kundid string

Name Namn string

StreetAddress Gatuadress string

PostalAddress Postadress string

ZipCode Postnummer string

City Ort string

Telephone Telefonväxel string

EmailAddress E-postadress string

HomepageUrl Url till hemsida string

ChangedAt När kontoret senast ändrades date

CorporateName Juridiskt namn string

CorporateNumber Organisationsnummer string

Logotype Logotyp LogotypeImage

Kodexempel

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

$URL = "https://connect.maklare.vitec.net/PublicAdvertising/Office/StringValue/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("PublicAdvertising/Office/StringValue/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 id = result.id.Value;
    // TODO: Gör något med resultatet
}

$URL = "https://connect.maklare.vitec.net/PublicAdvertising/Office/StringValue/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["id"];
// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
{
  "id": "sample string 1",
  "customerId": "sample string 2",
  "name": "sample string 3",
  "streetAddress": "sample string 4",
  "postalAddress": "sample string 5",
  "zipCode": "sample string 6",
  "city": "sample string 7",
  "telephone": "sample string 8",
  "emailAddress": "sample string 9",
  "homepageUrl": "sample string 10",
  "changedAt": "2024-05-02T07:39:09.9918269+02:00",
  "corporateName": "sample string 12",
  "corporateNumber": "sample string 13",
  "logotype": {
    "id": "sample string 1",
    "dataChangedAt": "2024-05-02T07:39:09.9918269+02:00",
    "extension": "sample string 3"
  }
}
<Office xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.PublicAdvertisement">
  <ChangedAt>2024-05-02T07:39:09.9918269+02:00</ChangedAt>
  <City>sample string 7</City>
  <CorporateName>sample string 12</CorporateName>
  <CorporateNumber>sample string 13</CorporateNumber>
  <CustomerId>sample string 2</CustomerId>
  <EmailAddress>sample string 9</EmailAddress>
  <HomepageUrl>sample string 10</HomepageUrl>
  <Id>sample string 1</Id>
  <Logotype>
    <DataChangedAt>2024-05-02T07:39:09.9918269+02:00</DataChangedAt>
    <Extension>sample string 3</Extension>
    <Id>sample string 1</Id>
  </Logotype>
  <Name>sample string 3</Name>
  <PostalAddress>sample string 5</PostalAddress>
  <StreetAddress>sample string 4</StreetAddress>
  <Telephone>sample string 8</Telephone>
  <ZipCode>sample string 6</ZipCode>
</Office>