Web API > Web API HttpPost

De HttpPost aanroep wordt gebruikt om nieuwe gegevens toe te voegen aan de Logicworks CRM database. Om deze gegevens op te vragen dient te aanroepende partij te beschikken over de juiste Web API Authenticatie Token en schrijfrechten in het betreffende object.

HttpPost verwerken

Alvorens een externe partij voor een entiteit een HttpPost verzoek kan indienen bij de de Web API webservice moet in Logicworks CRM een Job zijn gedefinieerd om de aangeleverde gegevens te importeren in Logicworks CRM. In deze Job moeten een tweetal Web API gerelateerde velden worden ingevuld.

webapi-importjob

Web API Id

Bij de Web API HttpPost aanroep wordt gecontroleerd of er een Job bestaat met de opgegeven Web API Id. Bestaat geen Job met de opgegeven Id, dan wordt de Web API aanroep afgekeurd.

Web API Map

Komt een via de Web API doorgegeven Id overeen met een Job Web API Id, dan zal de doorgegeven Body Content als XML worden opgeslagen in deze map. De bestandsnaam wordt als volgt opgebouwd: {objectnaam}.yyyymmdd.uummss.xxx.XML. Tenslotte wordt een nieuwe Jobserver Trigger aangemaakt, zodat de Job bij de eerstvolgende gelegenheid door de Jobserver wordt verwerkt.

HttpPost aanroep

De Web API aanroep heeft altijd een vaste indeling, aangevuld met de Web API Token en eventuele extra selectieparameters.

https://www.logicworkcrm.nl/api/{object}?apitoken={token}&crmapi={id}

Met deze aanroep wordt een JSON-lijst geretourneerd van het opgegeven {object}.

https://www.logicworkcrm.nl/api/{object}/{id}?apitoken={token}

Met deze aanroep wordt een JSON-object geretourneerd met de detailgegevens behorende bij het opgegeven {id}.

HttpGet parameters

Er kunnen diverse parameters worden meegegeven met de Web API aanroep. Met uitzondering van de apitoken-parameter, welke altijd verplicht is, hebben deze parameters puur betrekking op de lijst-gerelateerde aanroep.

apitoken (verplicht)

Hiermee wordt Web API token doorgegeven

Voorbeeld

https://www.logicworkcrm.nl/api/contacts?apitoken=12345