De API geeft je de mogelijkheid om online meetings te starten vanuit je eigen applicatie, documenten / gegevens toe te voegen aan de meeting en weer terug te schrijven. Op deze pagina worden de Idiligo API GET en POST requests beschreven. Zie onderaan voor een voorbeeld.
1. Log in voor het verkrijgen van een beveiligingstoken
Om in te loggen heb je een Idiligo account met gebruikersnaam, wachtwoord en API-key. De API-key kan je vinden in je account instellingen. Door de aanvraag te doen krijg je een beveiligingstoken (token) die 24 uur geldig is.
| HTTP GET |
| GET /InsideService20.asmx/Login?apikey=string&username=string&password=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/Login HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length apikey=string&username=string&password=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
1a. Als alternatief kan je inloggen als een andere user zonder het wachtwoord te kennen
Als alternatief kan je inloggen zonder het wachtwoord van de gebruiker te kennen. Je hebt een username, API key en authorization ticket nodig. De API key / authorization ticket staan in de account settings.
Deze aanvraag levert een security token (token) op, welke 24 uur geldig is.
| HTTP GET |
| GET /InsideService20.asmx/Impersonate?apikey=string&username=string&ticket=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/Impersonate HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length apikey=string&username=string&ticket=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
2. Creëer een deelnemer voor je online meeting
Het is mogelijk om een deelnemer te creëren voor je online meeting. Om dit te kunnen doen heb je een beveiligingstoken (token) en mailadres (email), voornaam (firstName), achternaam (lastName) van de deelnemer nodig. Door deze aanvraag te doen krijg je een 'deelnemer- ID' (contactId).
| HTTP GET |
| GET /InsideService20.asmx/CreateContact?token=string&email=string&firstName=string&lastName=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/CreateContact HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&email=string&firstName=string&lastName=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
3. Creëer een online meeting
Om een online meeting te starten heb je een beveiligingstoken (token) en de code van het script (trajectCode) nodig die je wilt gebruiken voor je online meeting. Door deze aanvraag te doen krijg je een 'non-public meeting ID' (callId).
| HTTP GET |
| GET /InsideService20.asmx/CreateCall?token=string&trajectCode=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/CreateCall HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&trajectCode=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
4. Koppel de deelnemer aan de online meeting
Om de deelnemer aan de online meeting te koppelen heb je de beveiligingstoken (token) nodig, de 'non-public online meeting ID' (callId) en de 'deelnemers ID' (contactId).
| HTTP GET |
| GET /InsideService20.asmx/SetContact?token=string&callId=string&contactId=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK |
| HTTP POST |
| POST /InsideService20.asmx/SetContact HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&callId=string&contactId=string |
| HTTP/1.1 200 OK |
5. Genereer de url voor de organisator van de meeting
Om de organisator naar de meeting te laten gaan, kun je een url aanmaken. Hiervoor heb je de beveiligingstoken (token) en de 'non-public meeting ID' (callId) nodig. Let op, voor de deelnemer is een andere url van toepassing (zie punt 6).
| HTTP GET |
| GET /InsideService20.asmx/GetAgentUrl?token=string&callId=string&returnUrl=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/GetAgentUrl HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&callId=string&returnUrl=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
6. Genereer een url voor de deelnemer van de online meeting (public ID)
Om het mogelijk te maken voor de deelnemer om deel te nemen aan de meeting dient een url te worden gecreëerd.
Je kunt de url bouwen met de public ID (publicId). De url voor het deelnemen aan de online meeting is: https://app.idiligo.com/client?id=[publicId]. Deze aanvraag genereert de public ID (publicId). Hiervoor heb je de beveiligingstoken (token) en de non-public meeting-ID (callId) nodig. Let op: voor de organisator van de meeting geldt een andere url (zie punt 5).
| HTTP GET |
| GET /InsideService20.asmx/GetPublicCallId?token=string&callId=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/GetPublicCallId HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&callId=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
7. Optioneel: vooraf ingevulde waarden vanuit je applicatie toevoegen aan je online meeting
Het is mogelijk om vooraf ingevulde informatie vanuit je applicatie toe te voegen aan je online meeting. Hiervoor heb je de beveiligingstoken (token) en de Public ID (publicId) nodig. Tevens vul je de namen van de velden uit het script in (names) en de bijbehorende waardes (values) uit je eigen applicatie.
| HTTP GET |
| GET /InsideService20.asmx/SetValues?token=string&publicId=string&names=string&names=string&values=string&values=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK |
| HTTP POST |
| POST /InsideService20.asmx/SetLogin HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&publicId=string&names=string&names=string&values=string&values=string |
| HTTP/1.1 200 OK |
8. Optioneel: voeg documenten toe aan je online meeting
Je kunt in twee stappen documenten toevoegen aan je online meeting
Stap 1: upload het document in Idiligo
Voor deze stap heb je het volgende nodig: de beveiligingstoken (token) , locatie van het document (url), naam van het document (filename) en de naam van het document in het scrip (externalId). In het script heb je een node nodig van het type "Upload", met een bijbehorende externalId. Als resultaat ontvang je het ID van het document (documentId).
| HTTP GET |
| GET /InsideService20.asmx/AddDocumentFromUrl?token=string&apm;url=string&filename=string&externalId=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/AddDocumentFromUrl HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&url=string&filename=string&externalId=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
Stap 2: voeg het ge-uploaden document toe aan je online meeting
Om het document toe te voegen aan de online meeting heb het volgende nodig: beveiligingstoken (token), non-public meeting-ID (callId), het ID van het document (documentId) en de externalID zoals deze in het script wordt gebruikt. Het script dient een node van het type "Upload" met dezelfde externalId te bevatten.
| HTTP GET |
| GET /InsideService20.asmx/SetDocumentToUploadAction?token=string&callId=string&externalId=string&documentId=string HTTP/1.1 1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
| HTTP POST |
| POST /InsideService20.asmx/SetDocumentToUploadAction HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&callId=string&externalId=string&documentId=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
9. Download documenten uit de online meeting
Je kan documenten downloaden die zijn ge-upload/genereerd/ondertekend in de online meeting.
Je hebt hiervoor de beveiligingstoken (token) en de non Public meeting ID (callId) nodig. Als resultaat ontvang je de informatie over het document/documenten. Gebruik de url om het document te downloaden in je systeem. Deze url zal in de tijd wijzigen en Idiligo slaat documenten tijdelijk op.
| HTTP GET |
| GET /InsideService20.asmx/GetAttachments?token=string&callId=string HTTP/1.1 Host: app.idiligo.com |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfAttachmentDTO xmlns="http://www.idiligo.com/"><AttachmentDTO> <Id>long</Id> <Description>string</Description> <Url>string</Url> <Preview>string</Preview> <Attach>boolean</Attach> <Size>string</Size> <Date>string</Date> <SignUrl>string</SignUrl> <SignStatus>int</SignStatus> </AttachmentDTO> <AttachmentDTO> <Id>long</Id> <Description>string</Description> <Url>string</Url> <Preview>string</Preview> <Attach>boolean</Attach> <Size>string</Size> <Date>string</Date> <SignUrl>string</SignUrl> <SignStatus>int</SignStatus> </AttachmentDTO> </ArrayOfAttachmentDTO> |
| HTTP POST |
| POST /InsideService20.asmx/GetAttachments HTTP/1.1 Host: app.idiligo.com Content-Type: application/x-www-form-urlencoded Content-Length: length token=string&callId=string |
| HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> |
Ga naar de onderstaande link voor een overzicht van alle aanvragen:
http://app.idiligo.com/insideservice20.asmx