ImasCordHub Backend API Specification (0.0.1)

Download OpenAPI specification:Download

URL: https://misskey.io/@imas_cord_hub License: AGPL-3.0 License

(Caution) This API Specification is under development! Please excuse that some of the information and features are not available, enough, and correct. We are currently working very hard to develop this API now. Thank you for your understanding!

This is the specification for the ImasCordHub Backend API. ImasCordHub App uses this API to get all of informations of servers and fansites. And also it is available for those who need such informations as the developer through this API. The source code of this API is open at GitHub Repository. If you have any questions, please contact developer team through link below.

ImasCordHub Backend API Wiki

server

All Discord Server operations.

get all server information.

query Parameters

pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400

Content type

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub Official (Not exist!)",
"ip": "765as",
"waifu": ["天海春香"
],
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"invite": "https://discord.gg/exampleServerInviteLink",
"splash": "string"
}
]

submit a new server information. (Not implemented yet)

Responses

Response samples

202
400

Content type

application/json

{"reserved": "00000000-0000-0000-0000-000000000000",
"validation": "00000000-0000-0000-0000-000000000000",
"rel": {"status": {"uri": "/servers/status/{YOUR RESERVED UUID HERE}",
"method": "GET"
},
"get": {"uri": "/servers/findbyid/{YOUR RESERVED UUID HERE}",
"method": "GET"
},
"delete": {"uri": "/servers/findbyid/{YOUR RESERVED UUID HERE}",
"method": "GET"
}
}
}

get a server information with internal id.

query Parameters

serverId required	string <UUID> Example: serverId=00000000-0000-0000-0000-000000000000 The internal id of the server.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400
404

Content type

application/json

{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub Official (Not exist!)",
"ip": "765as",
"waifu": ["天海春香"
],
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"invite": "https://discord.gg/exampleServerInviteLink",
"splash": "string"
}

delete a server information with internal id. (Not implemented yet)

query Parameters

serverId

required

string <UUID>

Example: serverId=00000000-0000-0000-0000-000000000000

The internal id of the server.

header Parameters

validation_uuid

required

string

The validation UUID code for your server. You can use this ID to check the submit status of your server.

Responses

Response samples

400
404

Content type

application/json

{"error": "Invalid request."
}

get multiple server information with name.

query Parameters

name required	string Example: name=My Server The name of the server.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400
404

Content type

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub Official (Not exist!)",
"ip": "765as",
"waifu": ["天海春香"
],
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"invite": "https://discord.gg/exampleServerInviteLink",
"splash": "string"
}
]

get multiple server information with ip.

query Parameters

ip required	string Example: ip=765as The ip of the server.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400
404

Content type

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub Official (Not exist!)",
"ip": "765as",
"waifu": ["天海春香"
],
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"invite": "https://discord.gg/exampleServerInviteLink",
"splash": "string"
}
]

get multiple server information with waifu.

query Parameters

waifu required	string Example: waifu=My Waifu The waifu of the server.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400
404

Content type

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub Official (Not exist!)",
"ip": "765as",
"waifu": ["天海春香"
],
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"invite": "https://discord.gg/exampleServerInviteLink",
"splash": "string"
}
]

get a server information with validation UUID code. (Not implemented yet)

query Parameters

serverId required	string <UUID> Example: serverId=00000000-0000-0000-0000-000000000000 The internal id of the server.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

header Parameters

validation_uuid

required

string

The validation UUID code for your server. You can use this ID to check the submit status of your server.

Responses

Response samples

404

Content type

application/json

{"error": "The requested resource was not found."
}

fansite

All Fansite operations.

get all fansite information.

query Parameters

pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400

Content type

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub",
"waifu": "天海春香",
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"link": "https://example.com/"
}
]

submit a new fansite information. (Not implemented yet)

Responses

Response samples

202
400

Content type

application/json

{"reserved": "00000000-0000-0000-0000-000000000000",
"validation": "00000000-0000-0000-0000-000000000000",
"rel": {"status": {"uri": "/fansites/{YOUR RESERVED UUID HERE}/status",
"method": "GET"
},
"get": {"uri": "/fansites/findbyid/{YOUR RESERVED UUID HERE}",
"method": "GET"
},
"delete": {"uri": "/fansites/findbyid/{YOUR RESERVED UUID HERE}",
"method": "GET"
}
}
}

get a fansite information with internal id.

query Parameters

fansiteId required	string <UUID> Example: fansiteId=00000000-0000-0000-0000-000000000000 The internal id of the fansite.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400
404

Content type

application/json

{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub",
"waifu": "天海春香",
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"link": "https://example.com/"
}

delete a fansite information with internal id. (Not implemented yet)

query Parameters

fansiteId

required

string <UUID>

Example: fansiteId=00000000-0000-0000-0000-000000000000

The internal id of the fansite.

header Parameters

validation_uuid

required

string

The validation UUID code for your server. You can use this ID to check the submit status of your server.

Responses

Response samples

400
404

Content type

application/json

{"error": "Invalid request."
}

get multiple fansites information with name.

query Parameters

name required	string Example: name=My Server The name of the server.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400
404

Content type

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub",
"waifu": "天海春香",
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"link": "https://example.com/"
}
]

get multiple fansite information with waifu.

query Parameters

waifu required	string Example: waifu=My Waifu The waifu of the server.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

Responses

Response samples

200
400
404

Content type

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "ImasCordHub",
"waifu": "天海春香",
"description": "This is the official server of ImasCordHub. We are providing the information of servers and fansites of THE IDOLM@STER series!",
"link": "https://example.com/"
}
]

get a fansite information with validation UUID code. (Not implemented yet)

query Parameters

fansiteId required	string <UUID> Example: fansiteId=00000000-0000-0000-0000-000000000000 The internal id of the fansite.
pretty	boolean Default: false Example: pretty=true Whether to pretty print the response or not. (default false, true is recommended for faster response)
fields	string Example: fields=id,name,description The fields to be output. (default all fields, comma separated, unselected fields of value will be null)

header Parameters

validation_uuid

required

string

The validation UUID code for your server. You can use this ID to check the submit status of your server.

Responses

Response samples

404

Content type

application/json

{"error": "The requested resource was not found."
}

ImasCordHub Backend API Specification (0.0.1)

meta

health check for API.

Responses

Response samples

server

get all server information.

query Parameters

Responses

Response samples

submit a new server information. **(Not implemented yet)**

Responses

Response samples

get a server information with internal id.

query Parameters

Responses

Response samples

delete a server information with internal id. **(Not implemented yet)**

query Parameters

header Parameters

Responses

Response samples

get multiple server information with name.

query Parameters

Responses

Response samples

get multiple server information with ip.

query Parameters

Responses

Response samples

get multiple server information with waifu.

query Parameters

Responses

Response samples

get a server information with validation UUID code. **(Not implemented yet)**

query Parameters

header Parameters

Responses

Response samples

fansite

get all fansite information.

query Parameters

Responses

Response samples

submit a new fansite information. **(Not implemented yet)**

Responses

Response samples

get a fansite information with internal id.

query Parameters

Responses

Response samples

delete a fansite information with internal id. **(Not implemented yet)**

query Parameters

header Parameters

Responses

Response samples

get multiple fansites information with name.

query Parameters

Responses

Response samples

get multiple fansite information with waifu.

query Parameters

Responses

Response samples

get a fansite information with validation UUID code. **(Not implemented yet)**

query Parameters

header Parameters

Responses

Response samples

submit a new server information. (Not implemented yet)

delete a server information with internal id. (Not implemented yet)

get a server information with validation UUID code. (Not implemented yet)

submit a new fansite information. (Not implemented yet)

delete a fansite information with internal id. (Not implemented yet)

get a fansite information with validation UUID code. (Not implemented yet)