Getting Started
Om je data zo goed mogelijk te beschermen zijn de volgende restricties op het gebruik van de api van toepassing:
- De user/pass die je gebruikt moet een actieve licentie voor de huidige maand hebben. Dit hoeft geen extra gebruiker te zijn.
- Eenmalig dien je een verzoek in te dienen bij Simon Support om de api vrij te geven voor gebruik. Je ontvang via de mail een link met de URL, elke methode heeft daar documentatie.
- De verantwoording voor bescherming tegen ongeoorloofd gebruik, alsmede de integriteit / kwaliteit van data ligt daarna bij jou.
- De eerste drie maanden is het gebruik gratis, daarna bedragen de kosten € 448,- per jaar.
Je eigen koppeling
Om je eigen koppeling te maken heb je het volgende nodig:
- Je 16 cijferige Simon licentie-code
- Een Simon kantoorgebruikers naam (bv het emailadres van je aanvraag)
- Het wachtwoord van deze gebruiker
- Eenmalige aanvraag tot toegang tot de api
Simons Restserver ondersteund HTTP GET/POST, geen SOAP.
Simons Rest-server is Engelstalig opgezet. Ook de verschillende tabellen hebben Engelse namen.
De belangrijkste tabellen zijn:
Stamdata
Customer: Klant. Een Klant heeft 1 of meer Werkadressen
Location: Werkadres, daar waar de werkbon betrekking op heeft. Werkadres zonder Klant mag.
WorkOrder: De werkbon. Heeft altijd een Werkadres.
ItemGroup: Artikel Groep
Item: Artikelen. Een artikel mag in een Artikel Groep zitten
User: In het veld gebruikers OF op kantoor gebruikers
Planning: Planning bevat altijd een Werkbon en een Gebruiker
WorkOrderSurvey: Vragenlijst(en) bij een Werkbon. De vragenlijst zelf maak je in Simon
UsedItem: Verbruikt Materiaal op een Werkbon
TimeSheet: Reis- en Werktijd op een Werkbon
Workorder/digitalpresentation: De werkbon als PDF
Workordersurvey/digitalpresentation: De ingevulde vragenlijst als PDF
Algemeen
Haal volgens conform de omschrijving de Token op, met onderstaande informatie
Key = 16 cijferige licentiecode
Pwd = je eigen wachtwoord
Usr = je User name
Je krijgt een token. Dit token heb je bij elk request nodig. Een token expireert, zorg dat je bij het gebruik van Simons restserver het token regelmatig ververst!
Bekijk de HELP pagina bij Login, het TOKEN dien je bij elk Request in de HEADER mee te geven!
Methodiek
Simons Rest server werkt steeds hetzelfde, ongeacht de tabel. Onderstaand de uitleg voor tabel Location (=werkadres), deze uitleg is ook van toepassing op alle andere tabellen!
Met de acties:
location/insert
location/update
location/delete
Kun je werkadressen toevoegen, muteren en verwijderen. Voor Update en Delete dien je een Simon-Id mee te geven. Belangrijk: Simon kent altijd 2 Id’s. Het door Simon automatisch aangemaakt Id en JOUW sleutel/id. Dit heet binnen Simon ExtKey. ExtKey mag LEEG zijn, of een UNIEKE waarde hebben.
Om nu een Simon Id te vinden gebruik je: location/read
Hier kun je een aantal filterwaarden meegeven, raadpleeg de documentatie hoe je dat moet doen.
Je krijgt een lijst terug met Sleutels: Simon.Id-Simon.ExtKey
Vervolgens kun je met:
location/read/{id} (waarbij {id} het Simon.Id is)
Methode: location/readsync gebruiken als je bijvoorbeeld een Service maakt waarbij je jouw syste(e)m(en) gesynchroniseerd met Simon wilt houden. Je geeft een laatste mutatiedatum OF een laatst gebruikt Simon-Id door en je krijgt terug een lijst met alle Simon-Ids NA die datum of Simon-Id.
Voorwaarden voor het gebruik van de Simple-Simon api
Wanneer je gebruik wilt maken van de Simple-Simon api, dan gelden hiervoor de volgende voorwaarden:
- Stuur een e-mail naar support@simple-simon.net met het verzoek tot gebruikmaken. Wij zullen vervolgens je omgeving geschikt maken voor het gebruik van onze api’s.
- Je dient minimaal 1 actieve (betaalde) licentie te hebben om de api te gebruiken. Tijdens de free trial periode is het helaas niet mogelijk om gebruik te maken van Simple-Simon’s api.
- Het verstoren van je eigen Simple-Simon omgeving, de integratie met je ERP systeem en/of je agenda, door het gebruik van Simple-Simon’s api is op eigen risico.
- De verantwoording voor bescherming tegen ongeoorloofd gebruik, alsmede de integriteit / kwaliteit van data ligt daarna bij jou.
- Mocht ondersteuning vanuit ons IT team nodig zijn, dan bedragen de kosten hiervoor €1.200,- per man dag werken, hetgeen dat ook de minimale afname is.