NAV Navbar
Shell
  • Introduction
  • Authentication
  • Pages
  • Introduction

    The eventplanner.net API lets you build, enrich, integrate, ... websites and applications with eventplanner.net content including reviews. Our API is REST based with XML responses. The documentation for our API can be found below. You can view code examples of the shell commands in the dark area to the right.

    Authentication

    To authorize, use this code:

    # With shell, you can just pass the correct header with each request
    curl -X GET https://api.eventplanner.net/pages \
      --header 'X-API-KEY: 0011223344556677889900aabbccddeeff001122'
    

    Make sure to replace 0011223344556677889900aabbccddeeff001122 with your API key.

    To access the eventplanner.net API, you will need an API key. Contact us to obtain your API key.

    Pass your obtained API key as a header with name X-API-KEY.

    X-API-KEY: 0011223344556677889900aabbccddeeff001122

    {"message":"Missing Authentication Token"}
    # or
    {"message":"Unauthorized"}
    

    Calling the API with an incorrect API header will either result in a "Missing Authentication Token" message or an "Unauthorized" message.

    Pages

    Get All Available Pages

    GET /pages

    This endpoint retrieves all pages linked to your account.

    The above command returns XML structured like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <pages>
        <page>
            <id>1234</id>
            <name>Your page name</name>
        </page>
        <page>
            <id>1235</id>
            <name>Your other page name</name>
        </page>
    </pages>
    

    Responses

    Status Meaning Description
    200 OK all available pages

    Get a Specific Page

    GET /pages/{adv_ID}

    This endpoint retrieves a specific page. Depending on the type of account that you have, you can retrieve more detailed information for reviews.

    Parameters

    Parameter In Type Required Description
    adv_ID path string true The ID number of the page

    The above command returns XML structured like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <page>
        <id>1234</id>
        <name>Your page name</name>
        <url>https://www.eventplanner.be/bedrijven/1234_your-page-name.html</url>
        <ratings>
            <eventplanner max="10">9.5</eventplanner>
        </ratings>
        <reviews total="4" />
    </page>
    

    With an extended account you get the following XML for the same call. The is the link to the main business page of the account, the 's show the other pages we have for different markets. For every review we'll also offer the translations we have available together with an indication of their locale. If autotranslation=true this means the review is translated automatically, if false it's a manual translation by the user.

    <?xml version="1.0" encoding="UTF-8"?>
    <page>
        <id>1234</id>
        <name>Your page name</name>
        <url>https://www.eventplanner.be/bedrijven/1234_your-page-name.html</url>
        <alturls>
            <url country="BEL">http://www.be-fr.eventplanner.lan/directory/1234_your-page-name.html</url>
            <url country="NLD">http://www.nl.eventplanner.lan/bedrijven/1234_your-page-name.html</url>
            <url country="INT">http://www.en.eventplanner.lan/directory/1234_your-page-name.html</url>
            <url country="FRA">http://www.fr.eventplanner.lan/directory/1234_your-page-name.html</url>
            <url country="DEU">http://www.de.eventplanner.lan/directory/1234_your-page-name.html</url>
            <url country="GBR">http://www.uk.eventplanner.lan/directory/1234_your-page-name.html</url>
            <url country="IRL">http://www.ie.eventplanner.lan/directory/1234_your-page-name.html</url>
            <url country="LUX">http://www.lu.eventplanner.lan/directory/1234_your-page-name.html</url>
        </alturls>
        <ratings>
            <eventplanner max="10">9.5</eventplanner>
        </ratings>
        <reviews total="2">
            <review>
                <body>the text contents of the review</body>
                <translations autotranslation="true">
                    <translation autotranslation="true">
                        <locale>en</locale>
                        <subject>the subject of the review in en</subject>
                        <body>the text contents of the review in en</body>
                    </translation>
                    <translation autotranslation="true">
                        <locale>fr</locale>
                        <subject>the subject of the review in fr</subject>
                        <body>the text contents of the review in fr</body>
                    </translation>
                    <translation autotranslation="false">
                        <locale>de</locale>
                        <subject>the subject of the review in de</subject>
                        <body>the text contents of the review in de</body>
                    </translation>
                    <translation autotranslation="true">
                        <locale>es</locale>
                        <subject>the subject of the review in es</subject>
                        <body>the text contents of the review in es</body>
                    </translation>
                </translations>
                <created>2011-10-21T15:00:42+02:00</created>
                <likes>4</likes>
                <score max="5">4</score>
                <subject>the subject of the review</subject>
                <user>
                    <firstname>Smith</firstname>
                    <lastname>John</lastname>
                    <companyname>The Company</companyname>
                </user>
            </review>
            <review>
                <body>the text contents of the other review</body>
                <translations>
                    <translation autotranslation="true">
                        <locale>en</locale>
                        <subject>the subject of the review in en</subject>
                        <body>the text contents of the review in en</body>
                    </translation>
                    <translation autotranslation="true">
                        <locale>fr</locale>
                        <subject>the subject of the review in fr</subject>
                        <body>the text contents of the review in fr</body>
                    </translation>
                    <translation autotranslation="true">
                        <locale>de</locale>
                        <subject>the subject of the review in de</subject>
                        <body>the text contents of the review in de</body>
                    </translation>
                    <translation autotranslation="true">
                        <locale>es</locale>
                        <subject>the subject of the review in es</subject>
                        <body>the text contents of the review in es</body>
                    </translation>
                </translations>
                <created>2011-10-23T15:00:42+02:00</created>
                <likes>2</likes>
                <score max="5">5</score>
                <subject>the subject of the other review</subject>
                <user>
                    <firstname>Doe</firstname>
                    <lastname>Jane</lastname>
                    <companyname>The Other Company</companyname>
                </user>
            </review>
        </reviews>
    </page>
    

    Responses

    Status Meaning Description
    200 OK page details