Get data account

If you find any problem with API, please make an issue at GitHub


1.1 How to get data account using API


URL

To get data from your account using our API Rest is necessary to perform a POST call to the following URL (endpoint):

https://getoutpdf.com/api/account


GET Parameters

Our Rest API calls does not have parameters through GET


POST Parameters

  • api_keyApi key generated for our license. You can see your api key
    (string, required)
You can make a POST call using the HTML Header application/x-www-form-urlencoded, with the parameters described above.

Or you can send parameters via the JSON format, using the HTML Header application/json:

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

Example

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

Response

If the call is successful the response is a JSON with the following structure:

{
    "api_key": "64b5d1054b69e676b9984d8406c5209a6ba78...",      // string - Api key account
    "email": "example@example.com",                             // string - Email account
    "tokens_left": 303,                                         // integer - Tokens left
    "plan": "Premium",                                          // string - Plan account
    "status": "active",                                         // string - Estatus account - values: active|block
    "next_update": "2016-11-07 14:30"                           // string - Next update account - format: yyyy-MM-dd HH:mm:ss
}

Errors

If an error in sending parameters occurs, the response is a JSON with the following structure:

{
    "errors": {
        "param1": [     // string - Parameter name that generated the error
            "message"   // string - Error description
        ],
        "param2": [
            "message"
        ],
        ...
        "paramN": [
            "message"
        ]
    }
}

If an error occurs in the call, the answer will be a JSON with the following structure:

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