This defines the User Login API:
A Fax API request looks like:
https://fax.to/api/v2/user
This request contains:
The following table shows the parameters you use in the request:
Parameter | Description | Required |
---|---|---|
The unique email id of the user. | Yes | |
password | The password of the registered user | Yes |
To ensure privacy, you must use HTTPS for all Faxto API requests.
You submit all requests with a POST call using UTF-8 encoding and URL encoded values.
We support JSON ONLY responses
{
"status": "success",
"api_key": "f1a99500-7ce0-11e7-9fb1-0580e1fcb90c"
}
Key | Value | Response Type |
---|---|---|
status | The status of the API request | JSON |
api_key | The API key of the registered user | JSON |
HTTP Status Code | Reason |
---|---|
200 | Successful response |
401 | Unauthorized. |
403 | Rate limit exceeded |
404 | Resource not Found |
500 | Internal server error |