Developer Help

API Overview

The Xegesis content API is a simple RESTful API serving data in XML and JSON formats. The goal of this API is to allow automated access and publishing of Xegesis-generated content to your publishing platform. The current API Version is v1 and this document pertains to this version only.

The API endpoint URL (meaning the API 'home') is https://app.xegesis.eu/api/v1/. All methods use this URI as their base.

Authentication

Xegesis API Calls may or may not need authentication. If no authentication is needed, the call URI consists simply of the Endpoint URL, the Path and your favorite Format. Example:

http://app.xegesis.eu/api/v1/tournaments.json
^ Endpoint                   ^ Path      ^ Format

If Subaccount authentication is required, you will need to append your selected subaccount's API key to your request. Example:

http://app.xegesis.eu/api/v1/articles.json?key=VQhdnhMyPObIMWawEauakSvITugrdjAKNdCWmOlYLaSgczsbnsq
^ Endpoint                   ^ Path   ^ Format ^ Subaccount key

If Account authentication is required, you will need to append your access token key to your request. You can view your access token through the main menu under My Account > Access Token Example:

http://app.xegesis.eu/api/v1/balances.json?token=VQhdnhMyPObIMWawEauakSvITugrdjAKNdCWmOlYLaSgczsbnsq
^ Endpoint                   ^ Path   ^ Format   ^ Access token

Available Calls

Tournament List

Path Formats Auth Params Description
tournaments xml, jsonnonenonereturns the list of tournaments that users can subscribe to. Includes a tournament UUID that can be used to match the Xegesis content categorization with your publishing platform's categorization

Response Fields

name type Description
id UUID A UUID representing the league in Xegesis
name String The league name
Country String The country name

Example Response

// URI: https://app.xegesis.eu/api/v1/tournaments.json
=> [{
    "id": "1a6b75f3-fa6a-53ec-b47f-7190470f8554",
    "name": "Argentina Apertura/Clausura",
    "country": "Argentina"
},
{
    "id": "50c2db70-f722-5833-9697-a41bf2467e68",
    "name": "Austria 1. Bundesliga",
    "country": "Austria"
},
{
    "id": "267254d0-06ca-51fc-b4e1-95aeda3b7e38",
    "name": "Austria Erste Liga",
    "country": "Austria"
},
{
    "id": "61c4d021-a862-5910-a650-1fc22a04570d",
    "name": "Belgium Pro League",
    "country": "Belgium"
},
{
    "id": "14536b0c-8b9a-58cd-97ac-e9bc0fc92e5c",
    "name": "Brazil Serie A",
    "country": "Brazil"
},
{
    "id": "ed81c94b-0556-5345-ade5-2a3d1b915f9c",
    "name": "Germany Bundesliga",
    "country": "Germany"
}
]

Team List

Path Formats Auth Params Description
teams xml, jsonnonenonereturns the list of teams that users can subscribe to. Includes a team UUID that can be used to match the Xegesis content categorization with your publishing platform's categorization

Response Fields

name type Description
id UUID A UUID representing the team in Xegesis
name String The team name

Example response

// URI: https://app.xegesis.eu/api/v1/teams.json
=>[{"id":"d394201f-5848-5098-81cf-fe33c21674ae","name":"Apolonia"},
  {"id":"3dbc87d0-326c-512e-affa-8bce3a762488","name":"Besa"},
  {"id":"227f30d8-f85b-51f3-8761-00b84ccabdf5","name":"Din. Tirana"}]

Article Feed

Path Formats Auth Params Description
articles atom, rss, jsonSubaccountlocalereturns all articles currently available for a given subaccount. This call will only return current articles, not articles that have passed their expiration date.

Response Fields

name type Description
uuid UUID The article UUID
title String The article title
body String (HTML formatted) The article body
updated_at Timestamp Last article update
event JSON A representation of the event. Includes name and id
league JSON A representation of the event league. Includes name and id
sport String The event sport name
valid_until Timestamp The expiry date of the article. This can be the date of the event, or the date of an intermediate event that will change the data for the 2 teams. In the latter case, the articles will be regenerated at that time.

Example response

// URI: https://app.xegesis.eu/api/v1/articles.json?key=subaccount_api_key&locale=en_uk
[{
    "uuid": "3567d567-aa5e-5755-b6e2-96be1ee703d6",
    "title": "Manchester City-Manchester United",
    "body": "<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>",
    "updated_at": "2012-04-28T03:09:59Z",
    "event": {
        "uuid": "d08da77e-74db-5cde-a3ee-be27ac53b3a0",
        "name": "Manchester City-Manchester United"
    },
    "league": {
        "uuid": "e7226e20-301d-588d-ba6c-604d9c874cf2",
        "name": "Premier League"
    },
    "sport": "Soccer",
    "valid_until": "2012-04-28T18:00:00+02:00"
},
{
    "uuid": "d2945472-8cba-59d0-a41f-140e9a0be132",
    "title": "Tottenham-Blackburn",
    "body": "<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>",
    "updated_at": "2012-04-28T03:10:33Z",
    "event": {
        "uuid": "bb1c5227-b083-5f1a-a33a-de34b8630b45",
        "name": "Tottenham-Blackburn"
    },
    "league": {
        "uuid": "e7226e20-301d-588d-ba6c-604d9c874cf2",
        "name": "Premier League"
    },
    "sport": "Soccer",
    "valid_until": "2012-04-28T18:00:00+02:00"
},
{
    "uuid": "4213da6a-363b-5ed5-aabc-9cdff31674de",
    "title": "Belgrano-Tigre",
    "body": "<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>",
    "updated_at": "2012-04-28T03:11:06Z"
}]
developer_guide.txt · Last modified: 2012/10/05 16:24 by achillefs
Trace: developer_guide

© 2014, Xegesis.eu. All rights reserved