I Vitec Express så kan en användare skicka ett lead till en extern tjänst, som t ex en bank angående lånelöfte.
För att få en tät integrering i Vitec Express där det går att koppla in sig som en partner så har vi tagit fram nedan dokumentation.
Vi har möjlighet att anpassa formuläret som används för att skicka leadet.
Ni kan välja vilken information av nedan som ni vill visa:
Vissa anpassningar kräver utveckling av Vitec, kontakta oss för mer information.
Utöver vad som går att välja att visa så finns det möjlighet att lägga till validering på samtliga inmatningsfält. Om ni t ex har krav på att vissa uppgifter måste finnas för att ni ska kunna behandla leadet.
Börja med att registrera er i vår Connectportal.
Meddela oss på Vitec med följande information genom att klicka här:
Fundera gärna också på vilka metoder det är ni skulle behöva nyttja i Connect.
Tokenbaserad autentisering innebär att vi genererar en token och skickar med i alla anrop till er. Tokenet skickas med HTTP header "Authorization: Bearer {token}".
För att få ut parametrarna som rör tokenet och för att autentisera anropet, så anropa Connect via denna metod
Autentisering med basic authentication sker via HTTP headern "Authorization: Basic {value}".
För bättre autentiseringskydd så rekommenderar vi tokenbaserade autentiseringen.
Ingen autentisering
När en användare använder funktionen i Vitec Express för att skicka leadet, så kommer ni att få ett anrop till den URL ni meddelat oss med POST.
Ni kommer att få leadet i POST body och ni har möjlighet att returnera information till oss, se schema och JSON exempel nedan.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "OutgoingLeadPersonContract",
"type": "object",
"properties": {
"id": {
"description": "The contact id, which can be used in other API methods",
"type": ["string"]
},
"message": {
"description": "The message written by the sender",
"type": ["string"]
},
"address": {
"description": "The contact address",
"type": ["object"],
"properties": {
"streetAddress": { "type": ["string"] },
"zipCode": { "type": ["string"] },
"city": { "type": ["string"] }
},
"required": [],
"additionalProperties": false
},
"email": {
"description": "The contact email",
"type": ["object"],
"properties": {
"emailAddress": { "type": ["string"] }
},
"required": [],
"additionalProperties": false
},
"sender": {
"description": "The user who sent the lead",
"type": ["object"],
"properties": {
"id": { "type": ["string"] },
"name": { "type": ["string"] },
"email": { "type": ["string"] },
"telephone": {
"type": ["object"],
"properties": {
"work": { "type": ["string"] },
"workMsisdn": { "type": ["string"] },
"cell": { "type": ["string"] },
"cellMsisdn": { "type": ["string"] }
},
"required": [],
"additionalProperties": false
},
"office": {
"description": "The office which the user is currently working in",
"type": ["object"],
"properties": {
"customerId": { "type": ["string"] },
"name": { "type": ["string"] },
"place": { "type": ["string"] }
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"firstName": { "type": ["string"] },
"lastName": { "type": ["string"] },
"socialSecurityNumber": { "type": ["string"] },
"socialSecurityNumberSwedish": { "type": ["string"], description: "Social security number in YYYYMMDDNNNN format, 12 digits" },
"telephone": {
"type": ["object"],
"properties": {
"other": { "type": ["string"] },
"otherMsisdn": { "type": ["string"] },
"home": { "type": ["string"] },
"homeMsisdn": { "type": ["string"] },
"work": { "type": ["string"] },
"workMsisdn": { "type": ["string"] },
"cell": { "type": ["string"] },
"cellMsisdn": { "type": ["string"] }
},
"required": [],
"additionalProperties": false
},
"custom": {
"description": "Custom information that can be added with configuration, if you have something more you want the user to select, then please contact Vitec for further discussions",
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"required": ["id", "address", "telephone"],
"additionalProperties": false
}{
"id": "contact-123",
"message": "This is a message",
"address": {
"streetAddress": "Main Street 123",
"zipCode": "12345",
"city": "Stockholm"
},
"email": {
"emailAddress": "user@example.com",
},
"sender": {
"id": "agent-456",
"name": "Agent Smith",
"email": "agent.smith@example.com",
"telephone": {
"work": "010-1234567",
"workMsisdn": "46101234567",
"cell": "070-7654321",
"cellMsisdn": "46707654321"
},
"office": {
"customerId": "M11385",
"name": "Kontoret",
"place": "Göteborg"
}
},
"firstName": "John",
"lastName": "Doe",
"socialSecurityNumber": "900101-1234",
"socialSecurityNumberSwedish": "199001011234",
"telephone": {
"other": "08-111222",
"otherMsisdn": "468111222",
"home": "08-333444",
"homeMsisdn": "468333444",
"work": "08-555666",
"workMsisdn": "468555666",
"cell": "070-9876543",
"cellMsisdn": "46709876543"
},
"custom": {
/* Optional custom values, this is just an example, if you have none, there will be no properties here */
"leadType": "Bolån",
"preferedAgent": "agent@bank.com"
}
}{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "OutgoingLeadResult",
"type": "object",
"properties": {
"id": {
"description": "Your id of the lead for use in troubleshooting and reports",
"type": "string"
},
"data": {
"description": "Additional troubleshooting data",
"type": "string"
},
"message": {
"description": "A friendly message to show the user explaining what the issue was",
"type": "string"
},
"isSuccessful": {
"description": "Whether the lead was received successfully",
"type": "boolean"
}
},
"required": ["isSuccessful"],
"additionalProperties": false
}{
"id": "external-lead-001",
"isSuccessful": true
}