Eldra API

För att använda våra API:er behöver du ha ett konto i Eldra. Mejla oss gärna på info@eldra.ai så hjälper vi dig igång.

Välkommen till Eldras API-dokumentation

Här hittar du allt du behöver för att bygga en egen integration med Eldra. Vi samarbetar gärna med partners som vill koppla ihop sina system med vårt – på ett tryggt och smidigt sätt. Vill du komma igång med en integration? Hör av dig till oss på info@eldra.ai

Integration mot ditt system

Eldra kan koppla upp sig mot vilket affärs- eller planeringssystem som helst.
För att komma igång behövs bara två API-gränssnitt i systemet du vill integrera med:

Hämta alla kunder

Eldra synkar kundregistret från systemet varje natt. På så sätt finns alltid rätt kunder tillgängliga – uppdaterade och klara.Vi förväntar oss en lista tillbaka med följande data (namnen på attributen kan skilja sig):

[{
	"name": "string", // Can be firstName, lastName as well
	"phonenumber": "string",
	"id": "string", // Can be integer as well. Will be used when calling back into integrating system
	"street": "string",
	"city": "string",
	"postalCode": "string",
	"unitIdentifier": "string", // Identification for which unit (sv. "Enhet" / "Område") the client belongs to. 
}]

Hämta aktuellt schema

Eldra hämtar schemat för en kund när ett samtal startar. Schemat ska vara uppdaterat så att kunden alltid får rätt information.Vi skickar in följande parametrar (det går också bra att skicka dem som queryparametrar):

{
	"startDate": Date, // start date for schedule range, e.g right now
	"endDate": Date, // end date for schedule range, e.g in three days
	"clientId": "string", // Or number
}

Svarslistan bör innehålla följande data:

[{
	"startDate": Date, // start date and time for scheduled appointment
	"endDate": Date, // end date and time for scheduled appointment
	"type": "string", // name of task, e.g. "Hemmets skötsel"
	"by": "string", // name of the person scheduled to do the task
	"status": "string" // indicating if the appointment is cancelled or active
}]

För att underlätta vardagen för personalen kan Eldra också anropa följande gränssnitt

Skapa arbetsanteckning

Efter ett samtal mellan en klient och Eldra kan en arbetsanteckning automatiskt skapas i ert system. Det gör att personalen kan fortsätta arbeta i samma vy som vanligt.Eldra kan också skapa anteckningar på begäran under ett samtal med personal.Följande data skickas in:

{
	"message": "string" // the actual working note
	"by": "string" // either Eldra, or the staff name
	"clientId": "string" // Or number
}

Hämta kunskapsbas

Under samtal med personal kan Eldra svara på frågor om era rutiner och processer.Exempelvis vad man gör om ingen öppnar dörren, hur man hanterar en punktering – eller hur man sjukanmäler sig.Vi förväntar oss att kunna hämta materialet som filer eller text, via API-anrop eller nedladdningsbara länkar.

För djupare integrationer där även anhöriga och personal ska kunna ringas krävs följande gränssnitt:

Hämta alla anhöriga

Eldra synkar anhöriga från systemet varje natt. På så sätt kan anhöriga till kunder alltid få rätt information.Vi förväntar oss en lista tillbaka med följande data (namnen på attributen kan skilja sig):

[{
	"name": "string", // Can be firstName, lastName as well
	"phonenumber": "string",
	"id": "string", // Can be integer as well.
	"clients": [{
		"id": "string", // can be integer as well,
		"relationship": "string" // How they are related to the client. Not required to exists
	}], // Which client / clients they are a relative of, and how. Can be integer for id as well.
}]

Hämta all personal

Eldra synkar personal från systemet varje natt. På så sätt kan all personal alltid få kontakt och hjälp av Eldra. Vi skiljer på endpointsen för att hämta personal, och telefonnummer för personal, då dom flesta hemtjänstutförarna jobbar med en pool av telefoner som man tar när man börjar jobba. Därför håller vi en lista över både personal, och en lista över telefonnummer. Om ert system alltid kopplar 1-1 mellan personal och nummer kan vi hantera allt i ett anrop till ert systemVi förväntar oss en lista tillbaka med följande data (namnen på attributen kan skilja sig):

[{
	"name": "string", // Can be firstName, lastName as well
	"phonenumber": "string", // If they have a set phonenumber, should match phonenumers returned in "Fetch all staff numbers". Can be null / empty
	"email": "string", // can be null
	"id": "string", // Can be integer as well.
	"unitIdentifier": "string", // Identification for which unit (sv. "Enhet" / "Område") the staff belongs to. Should be the same as clients
}]

Hämta alla telefonnummer för personal

Eldra synkar telefonnummer för personal från systemet varje natt. På så sätt kan all personal alltid få kontakt och hjälp av Eldra. Vi skiljer på endpointsen för att hämta personal, och telefonnummer för personal, då dom flesta hemtjänstutförarna jobbar med en pool av telefoner som man tar när man börjar jobba. Därför håller vi en lista över både personal, och en lista över telefonnummer. Om ert system alltid kopplar 1-1 mellan personal och nummer kan vi hantera allt i ett anrop till ert systemVi förväntar oss en lista tillbaka med följande data (namnen på attributen kan skilja sig):

[{
	"phonenumber": "string",
	"unitIdentifier": "string", // Identification for which unit (sv. "Enhet" / "Område") the client belongs to. 
}]

Om ert system har en kunskapsbank som kan tillfrågas i naturellt språk kan vi anropa det direkt i samtal för personalen. Då behöver vi nedan gränssnitt:

Fråga kunskapsbas (genom LLM)

Under ett samtal med personal kan Eldra hämta information från er existerande kunskapsbank. I detta gränssnitt antas att det ligger en LLM mellan vår fråga och datan som ska sökasFöljande data skickas in:

{
	"query": "string" // the query of the user
	"unitIdentifier": "string" // the identifier of the staffs unit, if applicable
}

Förväntat svar:

{
	"response": "string" // the LLMs response of its data query
}

Fråga kunskapsbas (direkt)

Under ett samtal med personal kan Eldra hämta information från er existerande kunskapsbank. I detta gränssnitt antar vi att vi anroper en vector databas och låter därför en LLM förhantera kundens fråga och stycka upp den i flera frågor som passar vektordatabaser.Följande data skickas in:

{
	"queries": ["string"] // the vector storage queries generated from the user query
	"unitIdentifier": "string" // the identifier of the staffs unit, if applicable
}

Förväntat svar:

{
	"snippets": [{
		"documentId": "string", // id of the document where relevent information was found
		"body": "string" // the actual content from the document that is relevant
		"relevance": number // vector storage queries score of how relevant the document was
	}]
}

Vår LLM kommer sedan hantera svaret och ge ett svar till personalen.

Datastruktur

Här beskriver vi hur data struktureras i Eldra – för att underlätta samarbeten och integrationer.

Det här är den grundläggande datamodellen som behövs för att Eldra ska fungera. Det är inte all data som finns i systemet, men tillräckligt för att du ska kunna komma igång.

Entitet	Beskrivning	Behöver Entitet
Organisation	Den övergripande enheten där allt hänger ihop
Portal	Enhet i organisationen där kunder och konton kopplas in	Organisation
Client	Representerar en kund (brukare)	Portal
Account	Representerar en användare (personal)	Portal, Organisation
PhoneCall	Ett samtal mellan kund eller användare och Eldra AI	Client / Account
PhoneCallTranscriptLine	Varje meddelande från kund eller användare och Eldra AI	PhoneCall

Autentisering

Kom igång

Autentisering

Alla anrop kräver två HTTP-headrar för autentisering. Vi rekommenderar också att du sätter Content-Type för bästa upplevelse.

X-Portal-Id: '{portalId}'
Authorization: 'Bearer {token}'
Content-Type: 'application/json'

**X-Portal-Id **
ID för den portal som anropet gäller. Du hittar alla ID:n du har tillgång till via /me eller under Inställningar på https://app.eldra.ai/settingsAuthorization:
Standardheader för autentisering.
Token kan skapas under Inställningar i gränssnittet.

Upptäck våra gränssnitt

Till vänster ser du en lista över alla våra gränssnitt.Klicka på det du vill utforska för att läsa mer.

API dokumentation

Gränssnitt

Välkommen till Eldras API-dokumentation

Integration mot ditt system

Datastruktur

Autentisering

Kom igång

​Välkommen till Eldras API-dokumentation

​Integration mot ditt system

​Datastruktur

​Autentisering

​Kom igång

Välkommen till Eldras API-dokumentation

Integration mot ditt system

Datastruktur

Autentisering

Kom igång