Obtener datos cuenta

---

1.1 Cómo obtener datos de cuenta usando la API

URL

Para obtener los datos de tu cuenta usando nuestra API Rest es necesario realizar una llamada POST a la siguiente url:

https://getoutpdf.com/api/account

Parámetros GET

Nuestra API Rest no dispone de llamadas a través de parámetros GET

Parámetros POST

• api_keyApi key generada para nuestra licencia. Podemos ver nuestra api key en
  (string, required)

Puedes hacer una llamada POST, utilizando la cabecera html application/x-www-form-urlencoded, con los parámetros anteriormente descritos.

O también puedes enviar los parámetros a través del formato JSON, utilizando la cabecera html application/json:

{
    "api_key": "...",       // string, required
}

Ejemplo

{
    "api_key": "64b5d1054b69e676b9984d8406c5209a6ba78..."
}

Respuesta

Si la llamada se ha realizado correctamente la respuesta es un JSON con la siguiente estructura:

{
    "api_key": "64b5d1054b69e676b9984d8406c5209a6ba78...",      // string - Api key de la cuenta
    "email": "example@example.com",                             // string - Email de la cuenta
    "tokens_left": 303,                                         // integer - Créditos restantes
    "plan": "Premium",                                          // string - Plan de la cuenta
    "status": "active",                                         // string - Estado de la cuenta - values: active|block
    "next_update": "2016-11-07 14:30"                           // string - Próxima actualización de la cuenta - format: yyyy-MM-dd HH:mm:ss
}

Errores

Si se produce un error en el envío de parámetros, la respuesta será un JSON con la siguiente estructura:

{
    "errors": {
        "param1": [     // string - Nombre del parámetro que ha generado el error
            "message"   // string - Descripción del error
        ],
        "param2": [
            "message"
        ],
        ...
        "paramN": [
            "message"
        ]
    }
}

Si se produce un error en la llamada, la respuesta será un JSON con la siguiente estructura:

{
    "errors": [
        "message1",
        "message2",
        ...
        "messageN"
    ]
}