API Overview

Base URL

The base URL for all v1 end points is: https://api.multiplay.co.uk/cfp/v1

The base URL for all v2 end points is: https://api.multiplay.co.uk/cfp/v2

Response Status Codes

If the API call is authorized then the HTTP status code will be 200 OK

If the API call is not authorized then the HTTP status code will be 403 Forbidden

Response Format

All Clanforge API Version 1 (v1) calls return JSON formatted responses.

{
    "success" : <true|false>,
    "messages" : [
        {
            "level" : <level>,
            "lines" : ["line1", "line2", ..., "lineN"],
            "msgs" : [
                {
                    "level" : <level>,
                    "lines" : ["line1", "line2", ..., "lineN"],
                },
                ...
            ],
        },
        ...
    ],
    "error" : <true|false>,
    "error_code" : <integer>,
    "error_message" : "not authorised",
}
Variable Description Presence
success The <profileid> which identified the profile passed to a previous call to Mod Profile Diff Always
messages A subset of added_files <file_key>’s returned by a previous call to Mod Profile Diff Always but may be empty
message.level A subset of removed_files <file_key>’s returned by a previous call to Mod Profile Diff Always
message.lines A subset of modified_files <file_key>’s returned by a previous call to Mod Profile Diff Always
message.msgs A subset of modified_settings <setting_key>’s returned by a previous call to Mod Profile Diff Always
msg.level A subset of modified_settings <setting_key>’s returned by a previous call to Mod Profile Diff Always
msg.lines A subset of modified_settings <setting_key>’s returned by a previous call to Mod Profile Diff Always
error A subset of modified_settings <setting_key>’s returned by a previous call to Mod Profile Diff Only present if the API call failed
error_code A subset of modified_settings <setting_key>’s returned by a previous call to Mod Profile Diff Only present if the API call failed
error_message A subset of modified_settings <setting_key>’s returned by a previous call to Mod Profile Diff Only present if the API call failed
_debug A subset of modified_settings <setting_key>’s returned by a previous call to Mod Profile Diff Optional

Further Information