Exponera tjänster i Vitec Express
Beskrivning

Express Connect Tjänster är ett flöde för att exponera tjänster av tjänsteleverantörer direkt i Vitec Express.

Om t. ex. en användare vill att en expertfotograf ska ta bilder på ett hus, eller beställa marknadsföringsmaterial av en partner. För att förenkla beställningsarbetet och leveransen för användarna så kan ni integrera era tjänster i Express Connect.

Komma igång

Börja med att registrera er i vår Connectportal.

Meddela oss på Vitec med följande information genom att klicka här:

  • Partner id eller namn så att vi kan identifiera er i Connectportalen.
  • Namn på tjänsten.
  • Beskrivning av tjänsten.
  • Url som vi ska anropa vid en beställning av tjänsten.
  • Taggningar, ord som användaren ska kunna söka på för att hitta tjänsten.
  • Särskilda önskemål (Är det t. ex. endast vissa kunder som ska kunna beställa tjänsten?).

Fundera gärna också på vilka metoder det är ni skulle behöva nyttja i Connect.

Autentisering

Tokenbaserad autentisering innebär att vi genererar en token och skickar med i alla anrop till er. Tokenet skickas som en parameter i URL:en tillsammans med ett kund-id (customerId).

https://my-service.example/order?customerId=M123&token=B2aJbxq%2FHPX567%2F8QBjwuGxKtL1wcDF9amnY%2BJLe1BEff7qWesnZvw%3D%3D


För att få ut beställningsparametrarna så anropa Connect via denna metod

Autentisering med basic authentication, fungerar endast med asynkront flöde och används endast vid initiala anropet.

Vi skickar parametrarna direkt i URL:en.


För bättre autentiseringskydd så rekommenderar vi tokenbaserade autentiseringen. Den skyddar dessutom alla anrop och inte enbart initiala anropet.

Ingen autentisering, vi skickar parametrarna direkt i URL:en.

Flöde

Vi öppnar en ny sida hos er i samband med att användaren utför beställningen.

URL:en kan anropas upprepade gånger för samma order id. Ger möjlighet att användare kan gå tillbaka till eran sida efter beställningsförfarandet.

Ni kommer att behöva skicka ett anrop till Connect efter ni tagit emot beställningen där ni sätter order status till mottagen (OrderReceived) via denna metod.

Sekvensdiagram

Har ni ingen sida att visa i första läget, så kan ni använda detta bakgrundsflöde. Ni kan fortfarande skicka en länk som användaren kan öppna via användarinteraktionen i ett senare läge.

Beställningen kommer automatiskt sättas som mottagen (OrderReceived) efter vi har tagit emot ert svar.

Sekvensdiagram
Anrop för beställning

Det första anropet ni får är när vi kontaktar er angående en beställning. Ni kommer i samband med anropet få information om vad beställningen rör.

För bostäder så kommer ni att få följande information i anropet:

Via URL parametrar.

  • customerId, id på kontoret.
  • token, token.

Via Connect

  • OrderId, id på beställningen.
  • UserId, id på inloggad användare.
  • CustomerId, id på kontoret.
  • TenantId, id på kundens miljö.
  • ChainId, id på kedjan (Endast med om kontoret tillhör en kedja).
  • TargetId, id på bostaden.
  • TargetType, typen av bostad (Motsvarar de typer som går att hämta via Connect).
  • OrderUserId, ägare för beställningen.

Via URL parametrar.

  • orderId, id på beställningen.
  • userId, id på användaren som äger beställningen.
  • currentUserId, id på inloggad användare.
  • customerId, id på kontoret.
  • chainId, id på kedjan (Endast med om kontoret tillhör en kedja).
  • estateId, id på bostaden.
  • estateType, typen av bostad (Motsvarar de typer som går att hämta via Connect).

Vi vill att ni svarar med statuskod 200 så fort att ni har säkerställt att ni tagit emot beställningen, gärna innan ni har påbörjat behandlingen av beställningen.

T. ex. börja med att lagra beställningen i databasen, starta sedan en ny tråd som får behandla beställningen och svara sedan med statuskod 200.

Oväntade fel

Skulle det bli något fel som gör att det inte gör att slutföra beställningen så kan ni meddela användaren det genom att anropa Connect och uppdatera status på beställningen. Metoden för att uppdatera status finns här. Ange status "Error" och skicka med en beskrivning av felet.

Användarinteraktioner

Vissa problem kan användaren lösa och istället för att sätta status på beställningen till fel, så kan ni begära en interaktion av användaren. Det är också lämpligt att kräva en interaktion av användaren om användaren behöver göra val i beställningen.
Metoden för att kräva en användarinteraktion finns här. Ni anger en URL och en beskrivning som presenteras vid länken.

Leverera beställningen

Om det är lämpligt för er tjänst så kan ni leverera resultatet direkt till användaren genom att anropa Connect. Efter beställningen är färdig, så kan ni meddela användaren genom att sätta status till "Delivered".