Dataexport

Capitex dataexport används för att hämta ut information som våra användare anger i Capitex Säljstöd. Dataexporten består av en webbtjänst med ett antal metoder för att hämta ut den begärda informationen.

Standard innehåller följande metoder

HamtaLista - Metod för att hämta en lista med objekten som en licens har och när de senast uppdaterades
HamtaObjekt - Metod för att hämta information om ett objekt

Förklaringar

Ord	Förklaring
GUID	Vi använder en variant av GUID som består av 16 tecken.
Webbtjänst	En servertjänst för att skicka och ta emot data, se http://sv.wikipedia.org/wiki/Web_service för mer information
Cache	En lokal kopia av informationen för att slippa hämta från en server
Budgivning internet	En applikation utvecklad av Capitex för att automatisera en budgivning via internet
Boka visning internet	En applikation utvecklad av Capitex för att automatisera anmälning till visningar via internet

Teknisk dokumentation

Det här stycket förklarar hur ni ska använda Capitex dataexport för att hämta information.

Flöde

Innan detta flöde påbörjas så bör en hämtning av alla objekt göras. Detta görs genom att anropa HamtaLista och efter det så anropar ni HamtaObjekt för varje objekt som finns med i listan. Objekten sparar ni sedan i er databas och/eller cache.

Nedan följer den primära hämtningsmodellen för Capitex dataexport.

Kunden gör en överföring av objekt för publicering på Internet ifrån Capitex Säljstöd. Objektet förs då över från kundens lokala system till en central databas hos Capitex. Det är från denna databas som objektet sedan överförs till de olika marknadsplatserna och som mottagaren kan hämta information ifrån.
När överföringen är klar skickar Capitex ett meddelande till en förutbestämd extern mottagare att den aktuella kunden har gjort en överföring. Information som skickas till mottagaren är Capitex kundnummer (kontor). Informationen skickas med ”GET”. Mottagaren svarar ”OK” om det har gått bra att ta emot informationen eller ”FAIL” om det har misslyckats. OK eller FAIL skickas i bodyn i HTTP-svaret.
Mottagaren hämtar en lista med kundens objekt. Listan innehåller alla objekt kontoret har och när de uppdaterades senast. Se stycket "Hämta lista på uppdaterade objekt" för mer information
Mottagaren jämför med de objekten som de har och tar fram en lista på vilka objekt som har uppdaterats sen sist
Mottagaren hämtar nya och ändrade objekt, se stycket "Hämta information om ett objekt" för mer information
Mottagaren hämtar filer och bilder för de nya och ändrade objekten. Observera att för att få bäst prestanda så bör mottagaren även här kontrollera på ändrade objekt om de har nya eller uppdaterade bilder eller filer. Se styckena "Bilder" och "Filer" för mer information.

Listorna, objekten och bilderna måste mellanlagras på mottagarens server och får inte hämtas ondemand. D v s, varje bild och fil får bara hämtas från Capitex en gång efter den har förändrats.

Meddelande om uppdaterade objekt

När överföringen är klar skickar Capitex ett meddelande till en förutbestämd extern mottagare att den aktuella kunden har gjort en överföring. Information som skickas till mottagaren är Capitex kundnummer (kontor) och datakälla (var ifrån informationen skall hämtas på Capitex) . Informationen skickas med ”GET”. Mottagaren svarar ”OK” om det har gått bra att ta emot informationen eller ”FAIL” om det har misslyckats. OK eller FAIL skickas i bodyn i HTTP-svaret.

Exempel på url som vi anropar är:

http://www.kund.se/hamta.aspx?licenseId=[CPXKUNDNR]

[CPXKUNDNR] byts ut mot aktuellt kundnummer.

Vad domänen är och sidans namn är naturligtvis helt valfritt. Det Capitex behöver är mallen för hur länken ser ut (enligt exemplet ovan).

Tänk på att det är viktigt att ta emot kundnummer och använda sig av det vid hämtningen även om man bara jobbar med en kund. En kund kan ha flera kundnummer och genom att använda sig av kundnumret minskas mängden objekt som behöver kontrolleras vilket ökar prestandan.

Hämta lista på uppdaterade objekt

En standardlista med information om uppdaterade objekt går att hämta via webbtjänsten http://export.capitex.se/Gemensam/Export.svc, metoden heter HamtaLista och tar 3 parametrar.

licenseId - licensnummer som ni får utav oss
licenseKey - licensnyckel som ni får utav oss
kundnummer - Det kundnumret som skickas med i signalanropet

Skickas licensnumret in som kundnummer så hämtas alla objekt för alla kontor som är knutna till licensen.

Klicka här för dokumentation om objekten som returneras av webbtjänsten.

Hämta information om ett objekt

Information om ett objekt går att hämta på en webbtjänst som är anpassad för er. Denna information finns i ett separat dokument

Bilder

Bilder går att hämta via webbtjänsten http://export.capitex.se/Gemensam/Export.svc, metoden heter HamtaBild och tar 3 parametrar.

licenseId - licensnummer som ni får utav oss
licenseKey - licensnyckel som ni får utav oss
guid - bildens guid

Klicka här för dokumentation om objekten som returneras av webbtjänsten.

Filer

Filer går att hämta via webbtjänsten http://export.capitex.se/Gemensam/Export.svc, metoden heter HamtaFil och tar 3 parametrar.

licenseId - licensnummer som ni får utav oss
licenseKey - licensnyckel som ni får utav oss
guid - filens guid

Klicka här för dokumentation om objekten som returneras av webbtjänsten.

Felhantering

Då Capitex omöjligt kan garantera 100% upptid mellan klienten som hämtar och servern som levererar information är det viktigt att alla lösningar byggs med ordentlig felhantering.

Utgående signaler ifrån Capitex skickas om varje minut tills mottagaren svarar med ”OK” enligt punkt 2 i arbetsflödet

Likandant måste ett anrop (t.ex. en lista, beskrivning eller en bild) som misslyckas läggas i en kö för senare försök. Lämplig tid för nytt försök kan vara 5 minuter. Om hämtningen inte lyckats på 1-2 timmar bör ett larm gå så att problemet kan felsökas.

Säkerhet

För att kunna anropa Capitex web service måste Capitex få det IP-nummer som ska användas för hämtning. De IP-nummer som avses är de publika ip som syns när anrop görs själva anropet till Capitex servrar från utvecklingsmaskiner/servrar.