Glossary
Here is the glossary of all terms that are used within this document.
|
Term |
Abbreviation |
Definition |
|---|---|---|
|
Slug |
Slug |
A URL safe string used to identify an entity, usually generated by the name of the entity. |
API Endpoints
-
networks
-
Description: Use this service call to get information about networks supported by FMTC.
-
Example Request: http://s3.fmtc.co/api/4.0.0/networks?api_token=APIKEY
-
What’s New?
-
Return an error upon mismatching request parameters.
networks
Request Parameters
|
Name |
Value(s) |
Description |
Required |
Default |
|---|---|---|---|---|
|
api_token |
APIKEY |
API key for authentication, available on the API Keys & Calls page.(https://account.fmtc.co/cp/api_keys) |
Yes |
N/A, must always be provided |
|
format |
String XML, JSON, CSV, TAB, or PIPE |
Choose the feed format you would like returned. |
No |
JSON |
|
networkid |
Integer |
Choose the network ID that you wish to have returned. |
No |
N/A, by default all networks will be returned unless specified |
Implementation
Response Elements
|
Name |
Description |
|---|---|
|
slug |
The unique slug assigned to the network. |
|
name |
The human readable name of the network |
|
countries |
The two-letter country codes for the countries that the network supports. |
|
id |
The unique ID for the network that can be used across FMTC endpoints. |
Example Response - JSON
Here is an example of a JSON Response from the networks endpoint.
[
{
"id": 13,
"name": "Affiliate Future",
"slug": "AF",
"countries": [
"US",
"CA",
"UK"
]
}
]
Example Response - XML
Here is an example of an XML Response from the networks endpoint.
<?xml version="1.0" encoding="iso-8859-1" ?>
<network>
<id>13</id>
<name>Affiliate Future</name>
<slug>AF</slug>
<countries>
<country>US</country>
<country>CA</country>
<country>UK</country>
</countries>
</network>
Example Response - CSV
Here is an example of a JSON Response from the networks endpoint.
id,name,slug,countries
13,"Affiliate Future",AF,"[""US"",""CA"",""UK""]"
Example Response - TAB
Here is an example of a JSON Response from the networks endpoint.
id name slug countries
13 "Affiliate Future" AF "[""US"",""CA"",""UK""]"
Example Response - PIPE
Here is an example of a JSON Response from the networks endpoint.
id|name|slug|countries
13|"Affiliate Future"|AF|"[""US"",""CA"",""UK""]"