Finance.nl API
Finance.nl beschikt over een XML koppeling (API) waarmee vacatures geplaatst kunnen worden. Door de XML koppeling te gebruiken kunt u het plaatsen van vacatures automatiseren en koppelen aan uw eigen systemen of website(s).
Als u de XML koppeling wilt gebruiken kunt u contact opnemen met Jeroen Sentel (jsentel@cxomedia.nl). Finance.nl behoud zich het recht voor om zonder overleg vacatures te weigeren indien deze niet aansluiten bij de doelgroep van Finance.nl
De rest van deze pagina omschrijft de techniek die gebruikt wordt en hoe u de XML interface kunt gebruiken. Voor het lezen van deze instructies is het handig als u een basis kennis heeft van XML en HTTP requests.
Inhoud
- Hoe werkt het?
- XML Structuur
- Data velden
- Response
Hoe werkt het?
- Ontvangst XML data
- Controle en validatie
- Opslaan
- Rapportage
1. Ontvangst XML data
De XML data wordt door uw systeem via HTTP POST verstuurd naar
http://www.finance.nl/interface. De POST naam van de xml moet zijn:
data[interface][xml]. Verderop deze pagina vind u een voorbeeld en uitleg
over de XML structuur.
2. Controle en validatie
De XML interface controleert de xml structuur en kijkt of alle benodigde
gegevens aanwezig zijn. De interface controleert ook of de opgegeven
gebruikersnaam en wachtwoord kloppen en of de user de interface
mag gebruiken.
3. Opslaan
De XML interface schoont de data op zodat deze netjes in onze database gezet
kan worden. Bij opschonen kunt u denken aan het weghalen van html code
(Een lijst van toegestane html elementen vind u onderaan deze pagina). Zodra
de data is opgeslagen is de vacature direct zichtbaar op Finance.nl
4. Rapportage
De interface geeft een XML structuur terug (Response) waarin de status van
bepaalde acties staat. Mocht er gaandeweg iets fout zijn gegaan, dan kan u
makkelijk terug zien waar het probleem ligt, het is raadzaam de response te
bewaren als bestand in een map. Als er geen fouten zijn staat er ook de url in
waar de vacature op Finance.nl kan worden teruggevonden. Een volledige lijst van
meldingen en hun betekenis vind u onderaan deze pagina.
XML Structuur
Hieronder ziet u een voorbeeld van de xml structuur die gepost moet worden naar de interface. Het bestaat uit een blok xml met daarin twee blokken, settings en data. In het settings blok staan de username, password en actie die uitgevoerd moet worden. In het data blok staat de data waarmee gewerkt moet worden.
Voorbeeld
<?xml version="1.0" encoding="UTF-8" ?>
<xml>
<settings>
<license> </license>
<action> </action>
</settings>
<data>
<referentie> </referentie>
<expired> </expired>
<functie_titel> </functie_titel>
<functie_korte_omschrijving> </functie_korte_omschrijving>
<functie_omschrijving> </functie_omschrijving>
<functie_organisatie> </functie_organisatie>
<functie_afdeling> </functie_afdeling>
<functie_regio> </functie_regio>
<functie_plaats> </functie_plaats>
<functie_postcode_cijfers> </functie_postcode_cijfers>
<functie_postcode_letters> </functie_postcode_letters>
<functie_beroepsveld> </functie_beroepsveld>
<functie_branche> </functie_branche>
<functie_salaris> </functie_salaris>
<functie_salaris_eenheid> </functie_salaris_eenheid>
<functie_opleidingsniveau> </functie_opleidingsniveau>
<functie_ervaring> </functie_ervaring>
<functie_aanstelling> </functie_aanstelling>
<functie_dienstverband> </functie_dienstverband>
<contact_persoon> </contact_persoon>
<contact_telefoon> </contact_telefoon>
<contact_adres> </contact_adres>
<contact_postcode> </contact_postcode>
<contact_plaats> </contact_plaats>
<contact_email> </contact_email>
<contact_website> </contact_website>
</data>
</xml>
Verplichte velden
Een aantal velden zijn verplicht om vacatures te plaatsen. Dit heeft als reden
de weergave op de website, unieke indentificatie van de vacature en autenticatie
van de user. De verplichte velden voor het toevoegen, wijzigen of verwijderen
van een vacature zijn:
- license
- action
- referentie
- functie_titel*
- functie_omschrijving*
- functie_organisatie*
- functie_plaats*
- contact_email*
* Niet verplicht voor verwijderen van een vacature
(<action>delete</action>)
Data velden
Hieronder vindt u de lijst met alle velden in de XML structuur en de bijbehorende mogelijkheden.
| VELD | WAARDEN | OPMERKING |
|---|---|---|
| SETTINGS | ||
| license | licentie | De licentie die u ontvangen heeft van Finance.nl (Om uw xml te testen kunt u 'test' als licentie gebruiken, de vacature wordt dan niet opgeslagen, maar u kunt wel de response testen). |
| action | add/delete | Bij add horen meer verplichte velden dan bij delete, zie ook 'verplichte velden' hierboven. Als de action 'add' is en de vacature bestaat al in onze database, dan wordt deze automatisch overschreven. Bij elke vacature moet de combinatie van het account en de referentie uniek zijn. |
| DATA | ||
| referentie | Vrij | Aan deze code kunt u de vacature herkennen en wordt gebruikt door de interface om vacatures van elkaar te onderscheiden. |
| expired | YY-MM-DD | Vanaf deze datum zal de vacature niet meer zichtbaar zijn. Maximaal 1 maand vooruit. |
| functie_titel | Vrij | Titel van de functie/vacature. Deze wordt gebruikt in de overzichten en in de titels van de pagina. |
| functie_korte_omschrijving | Vrij | Korte omschrijving van de functie (maximaal 255 tekens). Deze wordt gebruikt in sommige overzichten en bij spotlight-vacatures. U mag hierin geen HTML opmaak gebruiken. |
| functie_omschrijving | Vrij | Volledige omschrijving van de functie. U mag hierin HTML opmaak gebruiken.
Toegestane HTML elementen zijn: <p> <h1> t/m <h6> <b> <i> <u> <center> <ul> <ol> <li> <br> en <img>. |
| functie_organisatie | Vrij | Naam van de organisatie van de vacature, als deze informatie niet vrijgegeven wordt, omschrijf de organisatie dan zo kort mogelijk. |
| functie_afdeling | Vrij | Afdeling binnen de organisatie. |
| functie_regio | Vrij | De regio waar de werkplek zich bevindt. |
| functie_plaats | Vrij | De plaatsnaam waar de werkplek zich bevindt. |
| functie_postcode_cijfers | 9999 | De cijfers van de postcode van waar de werkplek zich bevindt. Ten behoeve van o.a. Google Maps. |
| functie_postcode_letters | AA | De letters van de postcode van waar de werkplek zich bevindt. |
| functie_beroepsveld | Vrij | Beroepsveld |
| functie_branche | Vrij | Branche |
| functie_salaris | Getal | Salaris indicatie |
| functie_salaris_eenheid | Vrij | Eenheid: uur, maand of jaar |
| functie_opleidingsniveau | Vrij | Opleidingsniveau |
| functie_ervaring | Getal | Minimaal aantal jaar ervaring |
| functie_aanstelling | Getal | Aantal uur per week |
| functie_dienstverband | Vrij | Korte omschrijving van het dienstverband, part-time, full-time, project, interim etc. |
| contact_persoon | Vrij | Volledige naam van de contactpersoon van de vacature |
| contact_telefoon | Vrij | Telefoonnummer van de contactpersoon |
| contact_adres | Vrij | Straatnaam+nummer van de contactpersoon |
| contact_postcode | Vrij | Postcode van de contactpersoon |
| contact_plaats | Vrij | Plaats van de contactpersoon |
| contact_email | E-mail adres van de contactpersoon. Kan ook het sollicitatie e-mail adres van een recruiter zijn. | |
| contact_website | URL | Website van de contactpersoon. Bedoeld voor meer informatie over de organisatie of vacature. |
Voor een aantal velden is het aan te raden u aan de conventies van Finance.nl te houden, dit i.v.m. bladeren, zoekformulieren en vindbaarheid op de site.
Response
Hieronder ziet u hoe de response eruit kan zien. Verderop vindt u ook een lijst met uitleg over errors.
Voorbeeld (zonder errors)
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<parse_xml>ok</parse_xml>
<settings_structure>ok</settings_structure>
<data_structure>ok</data_structure>
<license>ok</license>
<required_referentie>ok</required_referentie>
<required_functie_titel>ok</required_functie_titel>
<required_functie_omschrijving>ok</required_functie_omschrijving>
<required_functie_organisatie>ok</required_functie_organisatie>
<required_functie_plaats>ok</required_functie_plaats>
<required_contact_email>ok</required_contact_email>
<action>edit</action>
<save>ok</save>
<job_id>4760</job_id>
<url>http://www.finance.nl/vacatures/view/4760</url>
</response><!-- 0.14s -->
Voorbeeld (met errors)
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<parse_xml>ok</parse_xml>
<settings_structure>ok</settings_structure>
<data_structure>ok</data_structure>
<license>ok</license>
<required_referentie>ok</required_referentie>
<required_functie_titel>ok</required_functie_titel>
<required_functie_omschrijving>ok</required_functie_omschrijving>
<required_functie_organisatie>ok</required_functie_organisatie>
<required_functie_plaats>ok</required_functie_plaats>
<required_contact_email>error: contact_email can not be empty</required_contact_email>
</response><!-- 0.14s -->
Hieronder vind u een lijst met codes en de waardes voor succes of failure.
| VELD | SUCCES | FAILURE | UITLEG (ERROR) |
|---|---|---|---|
| parse_xml | ok | XML Serializer could not parse XML | Als er geen geldige XML wordt gepost. Bijv. als velden niet worden afgesloten, of als er geen
<xml> container is. |
| settings_structure | ok | license or action is not present or empty | De settings structuur is niet in orde, license en action zijn verplicht. |
| data_structure | ok | data is not present or empty | Er is geen data aanwezig, of deze is leeg. |
| license | ok | license could not be found | De licentie is niet geldig |
| required_[veldnaam] | ok | [veldnaam] can not be empty | Het verplichte veld is leeg of niet aanwezig. |
| action | add/edit/delete | - | De actie die wordt uitgevoerd op de database (toevoegen, wijzigen of verwijderen) |
| save | ok | could not save data | Als het opslaan om onbekende reden niet is gelukt. |
| delete | ok | could not delete data / reference does not exist for user | Als het verwijderen om onbekende reden niet is gelukt. / De vacature die verwijderd moet worden bestaat niet. |
| job_id | [nummer] | - | Het identificatie nummer van de vacature. |
| url | [url] | - | De url waar de vacature is opgeslagen. Dit is standaard /vacatures/view/[job_id] |
