Clan API - Printable Version

Clan API - Printable Version

+- Limelight Forums (https://limelightgaming.net/forums)
+-- Forum: Community (https://limelightgaming.net/forums/forum-195.html)
+--- Forum: Updates (https://limelightgaming.net/forums/forum-254.html)
+---- Forum: General & Services (https://limelightgaming.net/forums/forum-334.html)
+---- Thread: Clan API (/thread-18989.html)

Clan API - Doctor Internet - Dec 29, 2017

A year ago, @goigle asked for a Clan API. We delivered.

Note: This is really aimed at people who have their own websites for their clans, with Steam Auth, to validate members and their ranks. It doesn't have much use for the general members.

API Base URL: https://limelightgaming.net/api/
This will return a 403, but you need to use a specific endpoint.

API Input Format. The APIs take GET params as input. Input can either be in the form of JSON, passed to the "input" GET param, or as individual GET params.
Upon error, the APIs return either an HTTP Error 400 or 500, depending on where the error occured. Along with this, additional data is returned via json (format param is ignored for this, errors are always returned as json)

All APIs accept "format" param to specific an output format. Acceptable Values: none, plain, json, json-pretty, xml

All APIs share a set of generic errors, from 1 to 100:

Code:
HTTP Code - Error Code - Error Type

400 - 1 - GET Array not specified.

400 - 2 - Missing Params.

400 - 3 - Malformed JSON.

400 - 4 - Bad Numeric Input.

Clan API - /clan/
Inputs:

Code:
id - Required - Clan ID to lookup.

Return:

Code:
clan member - 

    steamid

    name

    rankid

clan members - (array of clan member)

rank -

    rankid

    rankname

ranks - (array of rank)

Errors: 1001 - 1010

Code:
- 1001 - No clan found.

- 1002 - No rank data.

- 1003 - No clan members.

Clan Listing - /clan/list
Inputs:
Return:

Code:
clan - 

    name

    clanid

clans - (array of clan)

Errors: 1011 - 1020

Code:
500 - 1011 - No clans found.

We're hoping to expand this to include other things, but that's at a fairly low priority for us at the moment.
If there's something specific that you guys need to integrate Limelight into other services, feel free to pop a suggestion down.

RE: Clan API - roxas - Dec 29, 2017

Let's hope more clans will hop in there Big Grin

Good job!

RE: Clan API - Zona - Dec 29, 2017

Sounds very good!

RE: Clan API - Rizion - Dec 29, 2017

finally.

RE: Clan API - Cooli - Dec 29, 2017

Looks like a great start.