/
BulkGate developer documentation
/
URL shortener
/
Shortener examples
Shortener examples
Usage examples for the Shortener API . A link is created with shorten, pointed elsewhere with change and dropped with remove — all three work with the short URL returned by the first request.
Only the target address is mandatory. Without url_type the first domain from the list is used.
POST /api/1.0/shortener/shorten HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"target_url" : "www.bulkgate.com"
}
url_type picks the domain of the short link. The current list is returned by the `domains` endpoint .
POST /api/1.0/shortener/shorten HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"target_url" : "www.bulkgate.com" ,
"url_type" : "ms6.fr"
}
The link itself stays the same, only the address it points to changes — so it keeps working in messages that have already been sent.
POST /api/1.0/shortener/change HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"short_url" : "ur7.wf/K" ,
"target_url" : "www.insymbo.com"
}
Once deleted the link stops redirecting, including in messages that have already been sent with it.
POST /api/1.0/shortener/remove HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"short_url" : "http://ur7.wf/W"
}
The response is described in the specification .
Below is the same shorten request in different programming languages:
The meaning of the individual parameters is described in the specification .
php.net
$context = stream_context_create (['http' => [
'method' => 'POST' ,
'header' => 'Content-Type: application/json' ,
'content' => json_encode ([
'application_id' => 451,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'target_url' => 'www.bulkgate.com' ,
'url_type' => 'ur7.wf' ,
], JSON_THROW_ON_ERROR ),
'timeout' => 30,
'ignore_errors' => true ,
]]);
$body = file_get_contents ('https://portal.bulkgate.com/api/1.0/shortener/shorten' , false , $context );
if ($body === false )
{
throw new RuntimeException ('BulkGate API did not respond.' );
}
$response = json_decode ($body , true , flags : JSON_THROW_ON_ERROR );
if (isset ($response ['error' ]))
{
throw new RuntimeException ("BulkGate: {$response['error']} ({$response['type']})" );
}
echo "{$response['data']['short_url']}\n" ;
php.net/curl
$curl = curl_init ();
curl_setopt_array ($curl , [
CURLOPT_URL => 'https://portal.bulkgate.com/api/1.0/shortener/shorten' ,
CURLOPT_POST => true ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTPHEADER => ['Content-Type: application/json' ],
CURLOPT_POSTFIELDS => json_encode ([
'application_id' => 451,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'target_url' => 'www.bulkgate.com' ,
'url_type' => 'ur7.wf' ,
], JSON_THROW_ON_ERROR ),
]);
$body = curl_exec ($curl );
$status = curl_getinfo ($curl , CURLINFO_RESPONSE_CODE );
if ($body === false )
{
throw new RuntimeException ('BulkGate: ' . curl_error ($curl ));
}
$response = json_decode ($body , true , flags : JSON_THROW_ON_ERROR );
if ($status !== 200)
{
throw new RuntimeException ("BulkGate: {$response['error']} ({$response['type']})" );
}
echo "{$response['data']['short_url']}\n" ;
docs.guzzlephp.org
use GuzzleHttp\Client ;
use GuzzleHttp\Exception\GuzzleException ;
$client = new Client (['timeout' => 30, 'http_errors' => false]);
try
{
$result = $client ->post ('https://portal.bulkgate.com/api/1.0/shortener/shorten' , ['json' => [
'application_id' => 451,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'target_url' => 'www.bulkgate.com' ,
'url_type' => 'ur7.wf' ,
]]);
}
catch (GuzzleException $e )
{
throw new RuntimeException ('BulkGate: ' . $e ->getMessage (), previous : $e );
}
print_r (json_decode ((string ) $result ->getBody (), true , flags : JSON_THROW_ON_ERROR ));
go.dev
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main () {
url := "https://portal.bulkgate.com/api/1.0/shortener/shorten"
payload := strings.NewReader (`{"application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "target_url": "www.bulkgate.com", "url_type": "ur7.wf"}` )
req, _ := http.NewRequest ("POST" , url, payload)
req.Header.Add ("Content-Type" , "application/json" )
res, err := http.DefaultClient.Do (req)
if err != nil {
panic (err)
}
defer res.Body.Close ()
body, _ := io.ReadAll (res.Body)
fmt.Println (res.StatusCode, string (body))
}
python.org
import requests
response = requests.post('https://portal.bulkgate.com/api/1.0/shortener/shorten' , json = {
'application_id' : 451 ,
'application_token' : 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'target_url' : 'www.bulkgate.com' ,
'url_type' : 'ur7.wf' ,
}, timeout = 30 )
data = response.json()
if 'error' in data:
raise RuntimeError(f"BulkGate: {data['error']} ({data['type']})" )
print (data['data' ]['short_url' ])
nodejs.org
const response = await fetch ("https://portal.bulkgate.com/api/1.0/shortener/shorten" , {
method : "POST" ,
headers : { "Content-Type" : "application/json" },
body : JSON .stringify ({
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"target_url" : "www.bulkgate.com" ,
"url_type" : "ur7.wf"
}),
});
const result = await response.json ();
if (result.error ) {
throw new Error (`BulkGate : ${result.error } (${result.type })`);
}
console.log (result.data .short_url );
java.net.http.HttpClient
import java.net.URI ;
import java.net.http.HttpClient ;
import java.net.http.HttpRequest ;
import java.net.http.HttpResponse ;
HttpClient client = HttpClient .newHttpClient ();
HttpRequest request = HttpRequest .newBuilder ()
.uri (URI .create ("https://portal.bulkgate.com/api/1.0/shortener/shorten" ))
.header ("Content-Type" , "application/json" )
.POST (HttpRequest .BodyPublishers .ofString ("" "
{
"application_id" : 451 ,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"target_url" : "www.bulkgate.com" ,
"url_type" : "ur7.wf"
}"" "))
.build ();
HttpResponse <String > response = client.send (request, HttpResponse .BodyHandlers .ofString ());
System .out.println (response.statusCode () + " " + response.body ());
kotlinlang.org
import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse
val payload = """
{
"application_id": 451,
"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
"target_url": "www.bulkgate.com",
"url_type": "ur7.wf"
}
""" .trimIndent ()
val request = HttpRequest .newBuilder ()
.uri (URI .create ("https://portal.bulkgate.com/api/1.0/shortener/shorten" ))
.header ("Content-Type" , "application/json" )
.POST(HttpRequest .BodyPublishers.ofString (payload))
.build ()
val response = HttpClient .newHttpClient ().send (request, HttpResponse .BodyHandlers.ofString ())
println("${response.statusCode()} ${response.body()}" )
learn.microsoft.com
using System .Net.Http;
using System .Text;
var payload = """
{
"application_id": 451,
"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
"target_url": "www.bulkgate.com",
"url_type": "ur7.wf"
}
""" ;
using var client = new HttpClient ();
var response = await client.PostAsync (
"https://portal.bulkgate.com/api/1.0/shortener/shorten" ,
new StringContent (payload, Encoding .UTF8, "application/json" ));
Console .WriteLine ($"{(int) response.StatusCode} {await response.Content.ReadAsStringAsync()}" );
curl.se/libcurl
#include <curl/curl.h>
#include <iostream>
#include <string>
static size_t collect(char *data, size_t size, size_t nmemb, std::string *out)
{
out->append(data, size * nmemb);
return size * nmemb;
}
int main()
{
const std::string payload = R"json(
{
"application_id": 451,
"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
"target_url": "www.bulkgate.com",
"url_type": "ur7.wf"
}
)json" ;
CURL *curl = curl_easy_init();
if (curl == nullptr )
{
std::cerr << "curl_easy_init failed\n" ;
return 1 ;
}
curl_slist *headers = curl_slist_append(nullptr , "Content-Type: application/json" );
std::string body;
curl_easy_setopt(curl, CURLOPT_URL , "https://portal.bulkgate.com/api/1.0/shortener/shorten" );
curl_easy_setopt(curl, CURLOPT_HTTPHEADER , headers);
curl_easy_setopt(curl, CURLOPT_POSTFIELDS , payload.c_str());
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION , collect);
curl_easy_setopt(curl, CURLOPT_WRITEDATA , &body);
const CURLcode result = curl_easy_perform(curl);
long status = 0 ;
curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE , &status);
curl_slist_free_all(headers);
curl_easy_cleanup(curl);
if (result != CURLE_OK )
{
std::cerr << curl_easy_strerror(result) << "\n" ;
return 1 ;
}
std::cout << status << " " << body << "\n" ;
return 0 ;
}
ruby-lang.org
require 'json'
require 'net/http'
uri = URI ('https://portal.bulkgate.com/api/1.0/shortener/shorten' )
response = Net ::HTTP .post (uri, {
'application_id' => 451 ,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'target_url' => 'www.bulkgate.com' ,
'url_type' => 'ur7.wf'
}.to_json , 'Content-Type' => 'application/json' )
puts "#{response.code} #{response.body}"
curl.se
curl --request POST \\
--url https://portal.bulkgate.com/api/1 .0 /shortener/shorten \\
--header 'Content-Type: application/json' \\
--data '{"application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "target_url": "www.bulkgate.com", "url_type": "ur7.wf"}'
Was this page helpful?
thumb_up Yes
thumb_down No
Thank you for your feedback.