Support
Docs
Getting Started Api Docs

Guides

Talk to our active support team!

My Requests
General User Blocks Plan Analytics Pixels Activities

Api Documentation

This is the documentation for the available API endpoints, which are built around the REST architecture. All the API endpoints will return a JSON response with the standard HTTP response codes and need a Bearer Authentication via an API Key

Here's the base api url where you will send requests to with the endpoints
Api Url

Auth

All the API endpoints require an API key sent by the Bearer Authentication method

Example Request
curl --request GET \ --url 'http://fransvcard.com/api/v1/{endpoint}' \ --header 'Authorization: Bearer {api_key}' \

Example

Example method in different languages on how to post requests to our api

Curl
curl --request GET \ --url 'http://fransvcard.com/api/v1/{endpoint}' \ --header 'Authorization: Bearer {api_key}' \ -d {page: 2}
PHP
$url = 'http://fransvcard.com/api/v1/{endpoint}';
$body = [
      'page' => 2,
      'results_per_page' => 25,
];
$body = json_encode($body);
// Open connection
$ch = curl_init();
curl_setopt($ch,CURLOPT_URL, $url);
// Set either it's a POST or GET request
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch,CURLOPT_POST, true);
// Add post body array if available
// Uncomment this line if you want to post data to api
#curl_setopt($ch,CURLOPT_POSTFIELDS, $body);
// Your headers with api key as the Authorization Bearer
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {api_key}",
  "Cache-Control: no-cache",
  "Content-Type" => "application/json",
]);

//So that curl_exec returns the contents of the cURL; rather than echoing it
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);

//execute post
$result = curl_exec($ch);
// Echo Result
echo $result;
Laravel Guzzle HTTP
// Post URL
$url = 'http://fransvcard.com/api/v1/{endpoint}';
// Init Guzzel Client
$client = new \GuzzleHttp\Client();
// Set headers with api key as the Authorization Bearer
$headers = [
    'Content-Type' => 'application/json',
    'cache-control' => 'no-cache',
    'Authorization' => "Bearer {api_key}",
];
// Post data array
$body = [
    'page' => 1,
    'results_per_page' => 10,
];
$body = json_encode($body);
// Guzzle Content with headers and body
$content = ['headers' => $headers];
// Uncomment this line if you want to post data to api
#$content['body'] = $body;
// Post Content to api and Set either it's a POST or GET request
$response = $client->request('GET', $url, $content);
// Echo Result
echo $response->getBody()->getContents();