GET
https://test-api.finerworks.com/v3/test_my_credentials
Test Connection
Use this for your first test and make sure your credentials are linked to your FinerWorks account information.
Body
| Name | Description | Type | Additional information |
|---|---|---|---|
| credentials | Include your authorization credentials object here. | authorization_credentials |
Required |
Example JSON Body
application/json, text/json
{
"credentials": {
"web_api_key": "b2bce832-622d-4e95-8f4f-9034454a4a35",
"app_key": "89bc0d5d-ba42-4c43-8c93-641de5d3ca25"
}
}
Sample Code Library
curl --location --request GET 'https://test-api.finerworks.com/v3/test_my_credentials' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
"credentials": {
"web_api_key": "b2bce832-622d-4e95-8f4f-9034454a4a35",
"app_key": "89bc0d5d-ba42-4c43-8c93-641de5d3ca25"
}
}'require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-api.finerworks.com/v3/test_my_credentials');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
'credentials': {
'web_api_key': 'b2bce832-622d-4e95-8f4f-9034454a4a35',
'app_key': '89bc0d5d-ba42-4c43-8c93-641de5d3ca25'
}
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}var client = new RestClient("https://test-api.finerworks.com/v3/test_my_credentials");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
'credentials': {
'web_api_key': 'b2bce832-622d-4e95-8f4f-9034454a4a35',
'app_key': '89bc0d5d-ba42-4c43-8c93-641de5d3ca25'
}
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);var settings = {
"url": "https://test-api.finerworks.com/v3/test_my_credentials",
"method": "GET",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
'credentials': {
'web_api_key': 'b2bce832-622d-4e95-8f4f-9034454a4a35',
'app_key': '89bc0d5d-ba42-4c43-8c93-641de5d3ca25'
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});var https = require('follow-redirects').https;
var options = {
'method': 'GET',
'hostname': 'test-api.finerworks.com',
'path': '/v3/test_my_credentials',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) { chunks.push(chunk); });
res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) { console.error(error); });
});
var postData = JSON.stringify({
'credentials': {
'web_api_key': 'b2bce832-622d-4e95-8f4f-9034454a4a35',
'app_key': '89bc0d5d-ba42-4c43-8c93-641de5d3ca25'
}
});
req.write(postData);
req.end();require "uri"
require "net/http"
url = URI("https://test-api.finerworks.com/v3/test_my_credentials")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["web_api_key"] = "my-web-api-key-goes-here"
request["app_key"] = "my-app-key-goes-here"
request.body = "{
'credentials': {
'web_api_key': 'b2bce832-622d-4e95-8f4f-9034454a4a35',
'app_key': '89bc0d5d-ba42-4c43-8c93-641de5d3ca25'
}
}"
response = https.request(request)
puts response.read_body| Name | Description | Type | Additional information |
|---|---|---|---|
| status | response_status | None. | |
| user_account | user_account | None. |
Example JSON Response
application/json, text/json
{
"status": {
"success": true,
"status_code": 200,
"message": "",
"debug": null,
"reference_id": "8bc87d656a62499f8c34b7995c5054cb",
"domain": null
},
"user_account": {
"web_api_key": "90b6628d-fb9b-48ed-a9dc-cae6ba7c1ece",
"account_id": 1,
"account_username": "bob_ross",
"account_email": "bobbyross12@gmail.com",
"account_title": null,
"account_firstname": null,
"account_lastname": null,
"billing_info": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "12345"
},
"business_info": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "12345"
},
"logo_url": null,
"profile_img_url": null,
"payment_profile_id": null,
"user_account_credits": 0.0,
"enable_invoice_payment": false,
"account_key": null,
"shipping_preferences": [
0,
2,
1
],
"connections": null,
"user_profile_complete": false,
"order_fulfillment_checklist": null,
"app_details": null,
"personal_galleries": null,
"bio": null,
"gallery_theme": null,
"social_links": null,
"account_paypal": null,
"geogalleries_license": false
}
}