REST API reference

Complete reference on how to handle InfiniteProxies resources
Base URL: https://reseller.infiniteproxies.com/v2

  • Choose your API version
  • 2.0

Reseller

Reseller account

Get self account

This endpoint allows you to get the data of your Reseller account. Since v2.0!

Available in API versions: 2.0

REQUEST

get /@me

Path parameters

Ø

Query parameters

Ø

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Return self account data

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        username (string ) • The username of the account
        proxy_password (string ) • The authorization key for the proxies of that account
        balanceResidential ( integer ) • The residental MB balance of that account
        balanceMobile ( integer ) • The mobile MB balance of that account
    }

}

Example


{
    "status": {
        "code": 200,
        "message": "Success"
    },
    "payload": {
        "username": "infproxy_zero",
        "proxy_password": "bu25b2zuk5u2kv5uz2",
        "balanceResidential": 5000,
        "balanceMobile": 3000
    }
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Customer

Customer accounts

Create Customer

This endpoint allows you to create a customer account. Since v1.0!

Available in API versions: 2.0

REQUEST

post /customer/create

Path parameters

Ø

Query parameters

username ( string ) • The username of the new account, will be converted to lowercase.

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Create and return new customer account

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        username (string ) • The username of the account
        proxy_password (string ) • The authorization key for the proxies of that account
    }

}

Example


{
    "status": {
        "code": 200,
        "message": "User has been created. To prevent abuse, we substracted 100 MB from your balance"
    },
    "payload": {
        "username": "supercoolusername881",
        "proxy_password": "3nJBfwEqOxrRvFEA"
    }
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Get Customer

This endpoint allows you to get a customers account data. Since v2.0!

Available in API versions: 2.0

REQUEST

get /customer/@{username}

Path parameters

username ( string ) • The username of the account, don't forget the @.

Query parameters

Ø

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Return a single customer account

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        username (string ) • The username of the account
        proxy_password (string ) • The authorization key for the proxies of that account
        balance ( integer ) • The GB balance of that account
    }

}

Example


{
    "status": {
        "code": 200,
        "message": "Success"
    },
    "payload": {
        "username": "supercoolusername881",
        "proxy_password": "3nJBfwEqOxrRvFEA",
        "balance": 100
    }
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Not Found

Body Format application/json

The given customer does not exist or is not linked to your reseller account

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 404,
    "message": "Customer not found"
}

Get Customer Transactions

This endpoint allows you to get a customers account data consumes. Since v2.0!

Available in API versions: 2.0

REQUEST

get /customer/@{username}/transactions

Path parameters

username ( string ) • The username of the account, don't forget the @.

Query parameters

Ø

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Return the data consumptions in this account from the last 14 days

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        consumption (object ) : {
            2022-05-04 ( float ) • The amount of MB used on this day
            2022-05-05 ( float ) • The amount of MB used on this day
            2022-05-06 ( float ) • The amount of MB used on this day
            2022-05-07 ( float ) • The amount of MB used on this day
            2022-05-08 ( float ) • The amount of MB used on this day
            2022-05-09 ( float ) • The amount of MB used on this day
            2022-05-10 ( float ) • The amount of MB used on this day
            2022-05-11 ( float ) • The amount of MB used on this day
            2022-05-12 ( float ) • The amount of MB used on this day
            2022-05-13 ( float ) • The amount of MB used on this day
            2022-05-14 ( float ) • The amount of MB used on this day
            2022-05-15 ( float ) • The amount of MB used on this day
            2022-05-16 ( float ) • The amount of MB used on this day
            2022-05-17 ( float ) • The amount of MB used on this day
       }
    }

}

Example


{
    "status": {
        "code": 200,
        "message": "Success"
    },
    "payload": {
        "2022-05-04": 0,
        "2022-05-05": 0,
        "2022-05-06": 65.75,
        "2022-05-07": 0,
        "2022-05-08": 0,
        "2022-05-09": 0,
        "2022-05-10": 0,
        "2022-05-11": 0,
        "2022-05-12": 0,
        "2022-05-13": 0,
        "2022-05-14": 0,
        "2022-05-15": 0,
        "2022-05-16": 0,
        "2022-05-17": 0,
    }
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Not Found

Body Format application/json

The given customer does not exist or is not linked to your reseller account

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 404,
    "message": "Customer not found"
}

Get all customers

This endpoint allows you to get a all customers account data. Since v2.0!

Available in API versions: 2.0

REQUEST

get /customers

Path parameters

Ø

Query parameters

Ø

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Return all customers linked to this reseller account

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        users (object ) : [
           {
                username (string ) • The username of the account
                proxy_password (string ) • The authorization key for the proxies of that account
                balance ( integer ) • The GB balance of that account
            }
          ]
    }

}

Example


{
    "status": {
        "code": 200,
        "message": "Success"
    },
    "payload": {
        "users": [
            {
                "username": "supercoolusername881",
                "proxy_password": "3nJBfwEqOxrRvFEA",
                "balance": 100
            },
            {
                "username": "anothercoolusername8842",
                "proxy_password": "6s7zg78sgzhsk",
                "balance": 0
            }
        ]
    }
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Add balance to customer

This endpoint allows you to add balance to a customer account. Since v2.0!

Available in API versions: 2.0

REQUEST

post /customer/add_balance

Path parameters

Ø

Query parameters

username ( string ) • The username of the account, converted to lower case.

balance ( integer ) • The amount of MB to add. Minimum 10 and only steps of ten.

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Add balance to customer account

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        username (string ) • The username of the account
        balance ( integer ) • The GB balance of that account
    }

}

Example


{
    "status": {
        "code": 200,
        "message": "Successfully added balance"
    },
    "payload": {
        "username": "supercoolusername881",
        "balance": 150
    }
}

Bad Request

Body Format application/json

Can be caused by invalid parameters or form data

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 400,
    "message": "Invalid Form Data. [X] is required"
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Not Found

Body Format application/json

The given customer does not exist or is not linked to your reseller account

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 404,
    "message": "Customer not found"
}

Remove balance from a customer

This endpoint allows you to remove balance from a customer account. Since v2.0!

Available in API versions: 2.0

REQUEST

post /customer/remove_balance

Path parameters

Ø

Query parameters

username ( string ) • The username of the account, converted to lower case.

balance ( integer ) • The amount of MB to remove. Minimum 10 and only steps of ten.

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Remove balance from a customer account

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        username (string ) • The username of the account
        balance ( integer ) • The GB balance of that account
    }

}

Example


{
    "status": {
        "code": 200,
        "message": "Successfully removed balance"
    },
    "payload": {
        "username": "supercoolusername881",
        "balance": 100
    }
}

Bad Request

Body Format application/json

Can be caused by invalid parameters or form data

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 400,
    "message": "Invalid Form Data. [X] is required"
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Not Found

Body Format application/json

The given customer does not exist or is not linked to your reseller account

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 404,
    "message": "Customer not found"
}

Reset customer proxy password

This endpoint allows you to reset the proxy password from an account. Since v2.0!

Available in API versions: 2.0

REQUEST

post /customer/reset_password

Path parameters

Ø

Query parameters

username ( string ) • The username of the account, converted to lower case.

Headers

INFINITE-KEY • Authentication per API-Key X-INFINITE-KEY. Contact us for a key, minimum Master Plan required.

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Reset the proxy password from this account

Body Format application/json

Follow the standard format of the entity

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }
    payload (object ) : {
        username (string ) • The username of the account
        proxy_password (string ) • The authorization key for the proxies of that account

    }

}

Example


{
    "status": {
        "code": 200,
        "message": "Successfully resetted password"
    },
    "payload": {
        "username": "supercoolusername881",
        "proxy_password": "HTxkiReYi3jidSJD"
    }
}

Bad Request

Body Format application/json

Can be caused by invalid parameters or form data

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 400,
    "message": "Invalid Form Data. [X] is required"
}

Authentication required

Body Format application/json

Can be caused by a missing or expired token

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 401,
    "message": "Unauthorized"
}

Access forbidden

Body Format application/json

The API Key is most likely wrong or user has no permissions to execute this request

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 403,
    "message": "API Key is invalid"
}

Not Found

Body Format application/json

The given customer does not exist or is not linked to your reseller account

{

    status (object ) : {
        code ( integer ) • HTTP Status code of the request
        message ( string ) • Response message of the request
    }

}

Example


{
    "status": {
    "code": 404,
    "message": "Customer not found"
}