Pheenix API - API

Introduction

In this guide, you will find various methods along with examples that describe how to integrate and manage the Pheenix API within your web applications. This guide assumes that you are well versed with a programming language.

Note: This API code can be used with any programming language.

Step 1
To get started, send an email to support@pheenix.com requesting api access. Within the body of the email, please state

a. Your Pheenix Login
b. The ip address for the program that will interface with the Pheenix api. Only requests coming from this ip address will be allowed to connect to the Pheenix API.

Step 2
We will then reply back with your api key.

Step 3
Code your application.

To access the Pheenix API, use the HTTP GET or POST requests. POST parameter have higher precedence than GET.

For example, you can type (or paste) the following URL in your browser: https://api.pheenix.com/logout

This action will perform an HTTP GET request to the API method. The application itself can be written in any language that can make these requests to Pheenix API. The actions use HTTP protocol as an interface to communicate with Pheenix functionality via its API.

Code Examples

To access Pheenix API, you need to perform an HTTP GET or POST request to the URL https://api.pheenix.com/some_method_name, where some_method_name is a name of the API method you want to call.

The response is returned in JSON format.

If execution of the method is successful, the result is returned in success container with sub-containers values according to the invoked method, otherwise fail container will return an error description.

Sample Pheenix API Script (php)

To save time on your integration, we've precoded a sample api script written in php. You can use this as a starting point which should cut your development time significantly.
Click here to download: https://api.pheenix.com/static/download/pheenix_sample_api_script.rar

Methods


login

Description

Use this method to authorize your application to get access to private methods.

Authorization

Not required

Parameters

Parameter Description
login
Required: Yes
api_key
Required: Yes
Length: 15 characters

Responses

Response
{
    "success": true,
    "fail": [

    ]
}
{
    "success": false,
    "fail": [
        "Wrong authorization data. After 3 unsuccessful login attempts your account has been locked and you have to wait 30 minutes before trying to login again."
    ]
}

Examples


logout

Description

Use this method to logout your application.

Authorization

Not required

Responses

Response
{
    "success": true,
    "fail": [

    ]
}

Examples


add_backorders

Description

Use this method to add backorders.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes
type
Required: No
Allowed values: super_saver

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        "floridavacationrentalhomes.com"
    ],
    "fail": [

    ]
}
{
    "success": [

    ],
    "fail": {
        "floridavacationrentalhomes.com": "Unable to backorder this domain."
    }
}

Examples


cancel_backorders

Description

Use this method to delete backorders.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        "floridavacationrentalhomes.com"
    ],
    "fail": [

    ]
}
{
    "success": [

    ],
    "fail": {
        "floridavacationrentalhomes.com": "Unable to cancel this backorder."
    }
}

Examples


list_backorders

Description

Use this method to list your backorders.

Authorization

Required

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "tester.tv",
            "catch_date": "2013-11-26"
        },
        {
            "domain": "cobra.tv",
            "catch_date": "2013-11-28"
        },
        {
            "domain": "tran.com",
            "catch_date": null
        },
        {
            "domain": "water.com",
            "catch_date": null
        }
    ],
    "fail": [

    ]
}

Examples


push_domains

Description

Use this method to push domains.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes
alias
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": [
        {
            "lovers-world.com": "\"lovers-world.com\" doesn't belong to the current user"
        }
    ]
}
{
    "success": [

    ],
    "fail": [
        "Invalid target alias"
    ]
}
{
    "success": [
        "lovers-world.com"
    ],
    "fail": [

    ]
}

Examples


update_domain_nameservers

Description

Use this method to update domains nameservers.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes
nameserver1
Required: Yes
nameserver2
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        "007phoneagent.com"
    ],
    "fail": [

    ]
}
{
    "success": [

    ],
    "fail": [
        {
            "000soft.com": "\"000soft.com\" doesn't belong to the current user"
        },
        {
            "00-love6.com": "\"00-love6.com\" doesn't belong to the current user"
        }
    ]
}

Examples


list_domains

Description

Use this method to list your domains.

Authorization

Required

Parameters

Parameter Description
domains
Required: No

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "quality.net",
            "whois_create_date": "2013-11-02",
            "whois_expires_date": "2014-11-02",
            "nameservers": "ns1.pheenix.com,ns2.pheenix.com"
        },
        {
            "domain": "888.com",
            "whois_create_date": "2013-11-01",
            "whois_expires_date": "2014-11-01",
            "nameservers": "ns1.google.com,ns2.google.com"
        }
    ]
}

Examples


list_pending_deletes

Description

Use this method to list pending deletes.

Authorization

Required

Parameters

Parameter Description
day
Required: No
Range: [0; 4]
Type: Integer

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}

Examples


list_won_auctions

Description

Use this method to list won auctions.

Authorization

Required

Parameters

Parameter Description
domains
Required: No

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "2424mall.com",
            "high_bid": "0.00"
        },
        {
            "domain": "miamidolphinz.com",
            "high_bid": "0.00"
        },
        {
            "domain": "gogogadget.net",
            "high_bid": "135.00"
        },
        {
            "domain": "defiance.tv",
            "high_bid": "0.00"
        }
    ],
    "fail": [

    ]
}

Examples


list_lost_auctions

Description

Use this method to list lost auctions.

Authorization

Required

Parameters

Parameter Description
domains
Required: No

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "grabthedoor.com",
            "high_bid": "50.00"
        },
        {
            "domain": "tweedtester.com",
            "high_bid": "575.00"
        },
        {
            "domain": "ribbit321.com",
            "high_bid": "0.00"
        },
        {
            "domain": "88david.com",
            "high_bid": "220.00"
        }
    ],
    "fail": [

    ]
}

Examples


list_current_auctions

Description

Use this method to list current auctions.

Authorization

Required

Parameters

Parameter Description
domains
Required: No

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "hotel247.com",
            "high_bid": "95.00",
            "high_bidder": "roger_rabbit",
            "auction_end_datetime": "2013-11-30 00:00:00",
            "auction_end_second": "170969",
            "minimum_bid": "115"
        }
    ],
    "fail": [

    ]
}
{
    "success": [
        {
            "domain": "hotel247.com",
            "high_bid": "95.00",
            "high_bidder": "roger_rabbit",
            "auction_end_datetime": "2013-11-30 00:00:00",
            "auction_end_second": "170969",
            "minimum_bid": "120"
        }
    ],
    "fail": [

    ]
}

Examples


bid_auction

Description

Use this method to bid auctions.

Authorization

Required

Parameters

Parameter Description
domain
Required: Yes
bid_amount
Required: Yes
Type: Float

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": {
        "hotel247.com": "The auction has ended"
    }
}

Examples


list_marketplace

Description

Use this method to list marketplace items.

Authorization

Required

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "billionairebluprint.com",
            "high_bid": "25.00",
            "bidding_alias": "scalable1",
            "end_time": "01:59:53"
        },
        {
            "domain": "aainter3.net",
            "high_bid": "0.00",
            "bidding_alias": null,
            "end_time": "01:59:53"
        },
        {
            "domain": "amisragas.com",
            "high_bid": "0.00",
            "bidding_alias": null,
            "end_time": "01:59:53"
        }
    ],
    "fail": [

    ]
}

Examples


list_won_marketplace

Description

Use this method to list won marketplace items.

Authorization

Required

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "culebrarentals.com",
            "high_bid": "20",
            "end_time": "2015-03-16 11:30:00"
        },
        {
            "domain": "amisragas.com",
            "high_bid": "25",
            "end_time": "2015-03-10 11:30:00"
        }
    ],
    "fail": [

    ]
}

Examples


list_lost_marketplace

Description

Use this method to list lost marketplace items.

Authorization

Required

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "culebrarentals.com",
            "high_bid": "20",
            "end_time": "2015-03-16 11:30:00",
            "winner": "scalable"
        },
        {
            "domain": "amisragas.com",
            "high_bid": "25",
            "end_time": "2015-03-10 11:30:00",
            "winner": "pheenix"
        }
    ],
    "fail": [

    ]
}

Examples


list_current_marketplace

Description

Use this method to list current marketplace items.

Authorization

Required

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [
        {
            "domain": "billionairebluprint.com",
            "high_bid": "25.00",
            "bidding_alias": "scalable1",
            "end_time": "01:59:53"
        },
        {
            "domain": "aainter3.net",
            "high_bid": "0.00",
            "bidding_alias": "scalable1",
            "end_time": "01:59:53"
        },
        {
            "domain": "amisragas.com",
            "high_bid": "0.00",
            "bidding_alias": "pheenix",
            "end_time": "01:59:53"
        }
    ],
    "fail": [

    ]
}

Examples


bid_marketplace

Description

Use this method to bid marketplace.

Authorization

Required

Parameters

Parameter Description
domain
Required: Yes
bid_amount
Required: Yes
Type: Float

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": {
        "billionairebluprint.com": "The marketplace has ended"
    }
}
{
    "success": {
        "billionairebluprint.com": {
            "high_bid": "15.00",
            "end_datetime": "2015-03-20 12:36:02",
            "high_bidder": "scalable1",
            "minimum_bid": 30
        }
    },
    "fail": [

    ]
}

Examples


transfer_in_domains

Description

Use this method to transfer in domains. Be sure to use urlencoded entities of special characters like "&", "=", "[", "]", ":", "/", "?" and so on in parameter values while doing GET request instead of POST request

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes
authcodes
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": [
        {
            "lovers-world.com": "\"lovers-world.com\" doesn't belong to the current user"
        }
    ]
}
{
    "success": {
        "chowyunfat.com": "Domain has been scheduled for transfer in"
    },
    "fail": [

    ]
}

Examples


reseller_customer_create

Description

Use this method to create reseller customer

Authorization

Required

Parameters

Parameter Description
member_name
Required: Yes
Allowed characters: Alphabetical characters, numbers, underscores and dashes
member_password
Required: Yes
Min Length: 8 characters
Max Length: 16 characters
bidding_alias
Required: Yes
Allowed characters: Alphabetical characters, numbers, underscores and dashes
country_code
Required: Yes
Allowed values: --, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, YU, ZA, ZM, ZR, ZW
organization
Required: No
first_name
Required: Yes
last_name
Required: Yes
address1
Required: Yes
postal_code
Required: Yes
city
Required: Yes
state
Required: Yes
telephone_country_code
Required: Yes
Allowed values: --, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, YU, ZA, ZM, ZR, ZW
telephone_prefix
Required: Yes
telephone
Required: Yes
telephone_ext
Required: No
fax_country_code
Required: No
Allowed values: --, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, YU, ZA, ZM, ZR, ZW
fax_prefix
Required: No
fax
Required: No
email
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": true,
    "fail": [

    ]
}

Examples


reseller_check_domains_availability

Description

Use this method to check domains availability.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": [
        {
            "lovers-world.com": "Domain has been deleted"
        }
    ]
}
{
    "success": [
        "lovers-world.com"
    ],
    "fail": [

    ]
}

Examples


reseller_register_domains

Description

Use this method to register domains.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": [
        {
            "lovers-world.com": "Domain has been deleted"
        }
    ]
}
{
    "success": [
        "lovers-world.com"
    ],
    "fail": [

    ]
}

Examples


reseller_renew_domains

Description

Use this method to renew domains.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes
years
Required: Yes
Range: [2; 8]
Type: Integer

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": [
        {
            "lovers-world.com": "\"lovers-world.com\" doesn't belong to the current user"
        }
    ]
}
{
    "success": [
        "lovers-world.com"
    ],
    "fail": [

    ]
}

Examples


reseller_delete_domains

Description

Use this method to delete domains.

Authorization

Required

Parameters

Parameter Description
domains
Required: Yes

Responses

Response
{
    "success": false,
    "fail": [
        "You should be authorized to access this method"
    ]
}
{
    "success": [

    ],
    "fail": [
        {
            "lovers-world.com": "Domain has been deleted"
        }
    ]
}
{
    "success": [
        "lovers-world.com"
    ],
    "fail": [

    ]
}

Examples