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.
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.
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_php.rar
To save time on your integration, we've precoded a sample api script written in .NET. 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_dot_net.rar
| Parameter | Description | ||||
|---|---|---|---|---|---|
| login |
|
||||
| api_key |
|
| 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."
]
} |
| Response |
|---|
{
"success": true,
"fail": [
]
} |
| Parameter | Description | ||||
|---|---|---|---|---|---|
| domains |
|
||||
| type |
|
| 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."
}
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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."
}
} |
| 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": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
||
| alias |
|
| 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": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
||
| nameserver1 |
|
||
| nameserver2 |
|
| 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"
}
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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"
}
]
} |
| Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
| day |
|
| Response |
|---|
{
"success": false,
"fail": [
"You should be authorized to access this method"
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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": [
]
} |
| 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": "120"
}
],
"fail": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| alias |
|
| 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": [
]
} |
| Parameter | Description | ||||
|---|---|---|---|---|---|
| domain |
|
||||
| bid_amount |
|
| Response |
|---|
{
"success": false,
"fail": [
"You should be authorized to access this method"
]
} |
{
"success": [
],
"fail": {
"hotel247.com": "The auction has ended"
}
} |
| 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": [
]
} |
| 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": [
]
} |
| 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": [
]
} |
| 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": [
]
} |
| Parameter | Description | ||||
|---|---|---|---|---|---|
| domain |
|
||||
| bid_amount |
|
| 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": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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": "t2h80qy7 |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
||
| authcodes |
|
| 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": [
]
} |
| Parameter | Description | ||||
|---|---|---|---|---|---|
| domain |
|
||||
| first_name |
|
||||
| last_name |
|
||||
| organization |
|
||||
|
|||||
| country_code |
|
||||
| address1 |
|
||||
| city |
|
||||
| state |
|
||||
| postal_code |
|
||||
| telephone |
|
| Response |
|---|
{
"success": false,
"fail": [
"You should be authorized to access this method"
]
} |
{
"success": false,
"fail": [
"\"lovers-world.com\" doesn't belong to the current user"
]
} |
{
"success": true,
"fail": [
]
} |
| Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
| member_name |
|
||||||
| member_password |
|
||||||
| country_code |
|
||||||
| organization |
|
||||||
| first_name |
|
||||||
| last_name |
|
||||||
| address1 |
|
||||||
| postal_code |
|
||||||
| city |
|
||||||
| state |
|
||||||
| telephone_country_code |
|
||||||
| telephone_prefix |
|
||||||
| telephone |
|
||||||
| telephone_ext |
|
||||||
| fax_country_code |
|
||||||
| fax_prefix |
|
||||||
| fax |
|
||||||
|
| Response |
|---|
{
"success": false,
"fail": [
"You should be authorized to access this method"
]
} |
{
"success": true,
"fail": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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": [
]
} |
| Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
| domains |
|
||||||
| years |
|
| 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": [
]
} |
| Parameter | Description | ||
|---|---|---|---|
| domains |
|
| 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": [
]
} |
| Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
| domains |
|
||||||
| years |
|
| 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": [
]
} |