Classlife API v.0

Classlife API v.0

Classlife API v.0 nos permite realizar muchas acciones. Tenemos un único endpoint pero que, en función del parámetro "perform" realizará una acción u otra. En toda comunicación es obligatorio enviar la ApiKey activada por el centro.

API v.0
Endpoint único	https://xxxxxx.classlife.education/app/apilead.php
apiKey	{apiKey}
perform	{acción personalizada}
service	api

donde xxxxxx es el dominio de la web, {apikey} es la ApiKey autorizada para el servicio y la accion personalizada irá en función de la necessidad del servicio. service = api es un parámetro extra de control interno.

Respuestas del Servicio

La respuesta del servicio devuelve en formato JSON con la confirmación del "status" de la solicitud.

JSON

{
    status: "success",
    context: "texto descriptivo",
    data : [...]
}

Status	Description
Success	Todo ha funcionado correctamente
Error	Error en la solicitud

Verificación del Servicio

Para verificar la comunicación del servicio se puede realizar la llamada al servicio utilizando la acción "perform = status" la cual activará una petición de validación de credenciales y notificará el servicio.

GET

https://{dominio}.classlife.education/app/apilead.php
    service    =    api
    perform    =    status
    apiKey     =    {apiKey}