Clanes

Información básica para obtener datos de clanes.

Actualmente todas las peticiones utilizan como base la dirección https://api.mythmc.ovh/v1/... Puedes ver todas las peticiones posibles haciendo clic aquí.

Usar curl en la interfaz

  1. Instalar curl si no está instalado aún en tu ordenador. Puedes comprobarlo rápidamente desde la terminal de tu sistema operativo con el comando curl --version.

  2. Crear una clave de acceso si aún no tienes una. Para ello, ve al servidor e introduce el comando /api key. Puedes consultar esta llave en cualquier momento usando el comando /api key list.

  3. Ejecutar una consulta de prueba. Abre la terminal de tu sistema operativo y ejecuta cualquier petición especificando tu clave de acceso como header (mira el comando de abajo si no sabes cómo hacerlo). Si la petición se ejecuta correctamente obtendrás el código 200 junto a la respuesta.

Ejemplo:

curl -H "X-API-Key: clave-de-acceso" "https://api.mythmc.ovh/v1/clans/mythTest/stats

Incorporar el ejemplo en una IDE

Una vez hayamos comprobado que la conexión con la API es correcta y estable ya solo es cuestión de encontrar la forma de incorporar llamadas a una API REST usando tu lenguaje de programación de elección.

Por ejemplo, para el caso de Java:

class call {
	public static void main(String[] args) {
		HttpRequest request = HttpRequest.newBuilder()
				.uri(URI.create("https://api.mythmc.ovh/v1/clans/mythTest/stats"))
				//.header("X-mythAPI-Key", "tu-clave")
				.method("GET", HttpRequest.BodyPublishers.noBody())
				.build();
		// Faltaría guardar la respuesta
	}
}

O, si usamos JavaScript:

fetch('https://api.mythmc.ovh/v1/clans/mythTest/stats')
      .then(response => response.json())
      .then(json => console.log(json));

En Google encontrarás muchos más ejemplos de cómo integrar una API usando cualquier lenguaje de programación que se te ocurra.

Lista de peticiones posibles

Estas son todas las peticiones relacionadas con los clanes que puedes integrar.

Devuelve una lista con todos los clanes.

GEThttps://api.mythmc.ovh/v1/clans
Response

OK

Body
itemsstring

El nombre del clan.

Request
const response = await fetch('https://api.mythmc.ovh/v1/clans', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  "text"
]

Consulta un dato específico.

GEThttps://api.mythmc.ovh/v1/clans/{nombre}/{consulta}
Path parameters
nombre*string

El nombre del clan

consulta*enum

El dato a consultar

statsmembersinfo
Response

OK

Request
const response = await fetch('https://api.mythmc.ovh/v1/clans/{nombre}/{consulta}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Las {consultas} posibles son:

Consulta las estadísticas de un clan.

GEThttps://api.mythmc.ovh/v1/clans/{nombre}/stats
Path parameters
nombre*string

El nombre del clan

Response

OK

Body
namestring

El nombre del clan.

xpinteger

La cantidad de experiencia del clan.

totalKillsinteger

La cantidad de asesinatos del clan.

totalDeathsinteger

La cantidad de muertes del clan.

Request
const response = await fetch('https://api.mythmc.ovh/v1/clans/{nombre}/stats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "name": "text"
}

Consulta la información de un clan.

GEThttps://api.mythmc.ovh/v1/clans/{nombre}/info
Path parameters
nombre*string

El nombre del clan

Response

OK

Body
namestring

El nombre del clan.

tagstring

La etiqueta del clan.

extraFeaturesinteger

Expansiones adicionales.

establishedstring

La fecha en que se estableció el clan.

establishedBystring

El usuario que estableció el clan.

leaderstring

El líder actual del clan.

Request
const response = await fetch('https://api.mythmc.ovh/v1/clans/{nombre}/info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "name": "text",
  "tag": "text",
  "established": "text",
  "establishedBy": "text",
  "leader": "text"
}

Consulta los miembros de un clan.

GEThttps://api.mythmc.ovh/v1/clans/{nombre}/members
Path parameters
nombre*string

El nombre del clan

Response

OK

Body
clanstring

El nombre del clan.

usernamestring

El nombre del usuario.

Request
const response = await fetch('https://api.mythmc.ovh/v1/clans/{nombre}/members', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "clan": "text",
    "username": "text"
  }
]

Last updated