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.

get

Devuelve una lista con todos los clanes.

Authorizations

BasicAuth

AuthorizationstringRequired

Responses

200

OK

application/json

string[]Optional

El nombre del clan.

400

Petición inválida

get

/clans

HTTPcURLJavaScriptPython

GET /v1/clans HTTP/1.1
Host: api.mythmc.ovh
Authorization: Basic username:password
Accept: */*

[
  "text"
]

get

Consulta un dato específico.

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

nombrestringRequired

El nombre del clan

consultastring · enumRequired

El dato a consultar

Possible values:

Responses

200

OK

No content

400

Petición inválida

401

Falta la clave

404

El clan no existe

get

/clans/{nombre}/{consulta}

HTTPcURLJavaScriptPython

GET /v1/clans/{nombre}/{consulta} HTTP/1.1
Host: api.mythmc.ovh
Authorization: Basic username:password
Accept: */*

No content

Las {consultas} posibles son:

get

Consulta las estadísticas de un clan.

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

nombrestringRequired

El nombre del clan

Responses

200

OK

application/json

namestringOptional

El nombre del clan.

xpintegerOptional

La cantidad de experiencia del clan.

totalKillsintegerOptional

La cantidad de asesinatos del clan.

totalDeathsintegerOptional

La cantidad de muertes del clan.

400

Petición inválida

401

Falta la clave

404

El clan no existe

get

/clans/{nombre}/stats

HTTPcURLJavaScriptPython

GET /v1/clans/{nombre}/stats HTTP/1.1
Host: api.mythmc.ovh
Authorization: Basic username:password
Accept: */*

{
  "name": "text",
  "xp": 1,
  "totalKills": 1,
  "totalDeaths": 1
}

get

Consulta la información de un clan.

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

nombrestringRequired

El nombre del clan

Responses

200

OK

application/json

namestringOptional

El nombre del clan.

tagstringOptional

La etiqueta del clan.

extraFeaturesintegerOptional

Expansiones adicionales.

establishedstringOptional

La fecha en que se estableció el clan.

establishedBystringOptional

El usuario que estableció el clan.

leaderstringOptional

El líder actual del clan.

400

Petición inválida

401

Falta la clave

404

El clan no existe

get

/clans/{nombre}/info

HTTPcURLJavaScriptPython

GET /v1/clans/{nombre}/info HTTP/1.1
Host: api.mythmc.ovh
Authorization: Basic username:password
Accept: */*

{
  "name": "text",
  "tag": "text",
  "extraFeatures": 1,
  "established": "text",
  "establishedBy": "text",
  "leader": "text"
}

get

Consulta los miembros de un clan.

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

nombrestringRequired

El nombre del clan

Responses

200

OK

application/json

clanstringOptional

El nombre del clan.

usernamestringOptional

El nombre del usuario.

400

Petición inválida

401

Falta la clave

404

El clan no existe

get

/clans/{nombre}/members

HTTPcURLJavaScriptPython

GET /v1/clans/{nombre}/members HTTP/1.1
Host: api.mythmc.ovh
Authorization: Basic username:password
Accept: */*

[
  {
    "clan": "text",
    "username": "text"
  }
]