ip-pool API PHP v1.0.0

Readme Browse & Export Statistics API
Assets
Overview

The assetsapi/ip-pool v1.0.0 API is organized around multiple Web Services and protocols (REST, SOAP etc.). Allowing you to speed up the implementation by choosing the technology you are most familiar with and the one that best suits your needs.

Testing

You can use the assetsapi/ip-pool API in test mode, which does not affect your request limits. The API key you use to authenticate the request determines whether it is live mode or test mode.

We put a lot of time and effor for the API's to be backward compatible but with new features available this may not be possible. If you wish we can notify you when the new version of the API is released.

Base URL 
https://assetsapi.com/assetsapi/ip-pool/v1.0.0/rest

Choose the language you're going to use to implement the API. Examples will be adjusted accordingly.

Programming Language
PHP
Select library or framework
cURL with helpers function
Authentication

The assetsapi/ip-pool API uses API keys to authenticate requests. You can view and manage your API keys in the API Keys section.

Test mode secret keys have the prefix test_ and live mode secret keys have the prefix live_.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Credentials

Open your application configuration file, where you hold all sensitive information. This is the file where environment setup is stored, such as database credentials, cache drivers, API keys etc.
Add constant defines below to the configuration file.

Define API credentials  PHP via curl 
<?php // settings.php

// ...
defined("ASSETSAPI_IP_POOL_SECRET") OR
  define("ASSETSAPI_IP_POOL_SECRET",
    "test_YOUR_API_KEY_HASH");

defined("ASSETSAPI_IP_POOL_ENDPOINT") OR
  define("ASSETSAPI_IP_POOL_ENDPOINT",
    "https://assetsapi.com/assetsapi/ip-pool/v1.0.0/rest");
API key
PHP helpers function

Add the function below to your function helpers file. This makes the resources call examples more compact.

Define API function for fetching assets  PHP via curl 
<?php // helpers.php

if (!function_exists("assetsAPI")) {
    function assetsAPI($url, $secret, $params = [], $method = 'GET') {
        $curl = curl_init($url . "?" . ($params ? http_build_query($params) : null ));
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        curl_setopt($curl, CURLOPT_HTTPHEADER, [
            'Content-Type: application/json',
            'Authorization: Basic ' . base64_encode($secret),
        ]);

        // Execute cURL request
        if (false === $response = curl_exec($curl)) {
            $response = json_encode([
                "success" => false,
                "data" => null,
                "error" => [
                    "code" => 1001,
                    "message" => curl_error($curl),
                ],
            ]);
        }

        // Closes a cURL session and frees all resources
        curl_close($curl);

        return json_decode($response);
    }
}
Error Handling

The assetsapi/ip-pool v1.0.0 API uses conventional HTTP response codes and response body to indicate the success or failure of an API request.

In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with our server.

Error Response 
{   "success": false,
    "data": null,
    "pagination": null,
    "error": {
        "code": 1001,
        "message": "Could not resolve host"
    }
}
Codes & Messages
# Message Description
200 OK Everything worked as expected.
400 Bad Request The request was unacceptable, often due to missing a required parameter.
401 Unauthorized No valid API key provided.
402 Request Failed The parameters were valid but the request failed.
403 Forbidden The API key doesn't have permissions to perform the request.
404 Not Found The requested asset doesn't exist.
409 Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
422 Results Limit Reached You have reached or will soon reach your results limit.
429 Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 Server Errors Something went wrong on the server end. Those are logged and promptly fixed.
1001 Client Error eg: Could not resolve host.
GET   https://assetsapi.com/assetsapi/ip-pool/v1.0.0/rest/WrongAsset 
$url = ASSETSAPI_IP_POOL_ENDPOINT . "/WrongAsset";
$params = array (
);

$output = assetsAPI($url, ASSETSAPI_IP_POOL_SECRET, $params);
Response 
{   "success": false,
    "data": null,
    "pagination": null,
    "error": {
        "code": 404,
        "message": "The requested asset \"WrongAsset\" doesn't exist"
    }
}
Ips

assetsapi IP Pool

Attributes
 Example
integer id 1
PK
string ip 51.255.144.164
AssetsAPI server IP address
timestamp created_at 2021-09-02 12:33:01
Record creation timestamp
timestamp updated_at 2021-09-02 12:33:01
Record update timestamp
GET   https://assetsapi.com/assetsapi/ip-pool/v1.0.0/rest/ips 
$url = ASSETSAPI_IP_POOL_ENDPOINT . "/ips";
$params = array (
);

$output = assetsAPI($url, ASSETSAPI_IP_POOL_SECRET, $params);
Response 
{   "success": true, pagination: {...},
    "data": [
        {
            "id": 1,
            "ip": "51.255.144.164",
            "created_at": "2021-09-02 12:33:01",
            "updated_at": "2021-09-02 12:33:01"
        }, ...
    ]
}