Introduction
Welcome to the JotUrl API Version i1 ! This is the right place to find information on how to programmatically interact with the JotUrl interface.
Authentication Session token Step 1: acquiring a token
Example
{PUBLIC_KEY} = "ae7b4635320411fe"
{PRIVATE_KEY} = "9283c835ef5e21d3"
{GMT_DATETIME} = "2018-11-30T20:04Z"
{PASSWORD} = HMAC_SHA256({PRIVATE_KEY}, {PUBLIC_KEY} + ':' + {GMT_DATETIME}) =
= HMAC_SHA256("9283c835ef5e21d3", "ae7b4635320411fe:2018-11-30T20:04Z") =
= "e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa"
Request
https://joturl.com/a/i1/users/login?username=test@example.com&password=e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
The above request returns a JSON structured like this:
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
},
"result" : {
"session_id" : "93bed02bf74e191294e22da6272a18a8" ,
"datetime" : "2018-11-30T20:04Z"
}
}
Session authentication needs the generation of a session token session_id
that is used to sign all other request to the API endpoints.
To generate the session_id
you have to make a request (GET
or POST
) to the API endpoint:
https://joturl.com/a/i1/users/login?username={EMAIL}&password={PASSWORD}
where {EMAIL}
is the email you use to login the JotUrl dashaboard and {PASSWORD}
is obtained by using an HMAC_SHA256 hash function:
{PASSWORD} = HMAC_SHA256({PRIVATE_KEY}, {PUBLIC_KEY} + ':' + {GMT_DATETIME})
{PUBLIC_KEY}
and {PRIVATE_KEY}
are your public and private API keys, respectively (API Keys ).
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API key in publicly
accessible areas such as GitHub, client-side code, and so forth.
Parameter {GMT_DATETIME}
is the the GMT date/time in the format YYYY-MM-ddThh:mmZ
where:
YYYY is the full numeric representation of the year (4 digits)
MM is the month with leading zeros (01-12)
dd is the day with leading zeros (01-31)
T is the uppercase letter T
hh is the hour with leading zeros (00-23)
mm are the minutes with leading zeros (00-59)
Z is the uppercase letter Z
Parameter {GMT_DATETIME}
must be generated on a device as synchronized as possible with the GMT date/time (each request requires a new {GMT_DATETIME}
).
The examples in this section return the expected values for the HMAC_SHA256
hash, these values can be used to test the implementation of
the HMAC_SHA256
hash you are using.
Step 2: sign API calls
Example
_sid = {session_id} =
= "93bed02bf74e191294e22da6272a18a8"
_h = HMAC_SHA256({PRIVATE_KEY}, {session_id} + ':' + {GMT_DATETIME}) =
= HMAC_SHA256("9283c835ef5e21d3", "93bed02bf74e191294e22da6272a18a8:2018-11-30T20:04Z") =
= "c9afd295a66bdfd68b2ee5a6c1031ff343d17691d56af17504127cf22d5a9d5b"
Request
https://joturl.com/a/i1/users/info?_sid=93bed02bf74e191294e22da6272a18a8&_h=c9afd295a66bdfd68b2ee5a6c1031ff343d17691d56af17504127cf22d5a9d5b
Response
{
"status" : {
"code" : 500 ,
"text" : "INVALID session" ,
"error" : "" ,
"rate" : 0
},
"result" : []
}
Every request to API endpoints have to be signed with the parameters _sid
and _h
.
Where _sid
is the session token {session_id}
obtained in step 1 and _h
is generated with the same method used for the {PASSWORD}
parameter in step 1:
_h = HMAC_SHA256({PRIVATE_KEY}, {session_id} + ':' + {GMT_DATETIME})
Parameter {GMT_DATETIME}
is obtained in the same way and follows the same rules as in step 1.
The examples in this section return the expected values for the HMAC_SHA256
hash, these values can be used to test the implementation of
the HMAC_SHA256
hash you are using.
You can also send parameters _sid
and _h
in the request headers BUT they become sid
and h
respectively.
The session token
The session token session_id
expires approximately every 30 days, but may expire sooner due to various factors and if you call the API method users/logout .
As a best practice, we suggest you to continue to use it until you get an "INVALID session" error response from the API endpoint.
In this case, you have to restart the authentication procedure from the beginning.
The session token is not linked to the device that generated it and therefore can be used by several devices at the same time.
Do not generate a session token on every API call, this may cause your account to be blocked by our engine.
Examples
The examples in this section return the expected values for the HMAC_SHA256
hash, these values can be used to test the implementation of
the HMAC_SHA256
hash you are using. You can find SDKs and examples here .
PHP
PHP example.
<?php
function HMAC_SHA256 ( $private_key , $message , $time = null ) {
return hash_hmac (
'sha256' ,
$message . ':' . ( $time ?: gmdate ( "Y-m-d\TH:i\Z" , time () ) ),
$private_key
);
}
$public_key = "ae7b4635320411fe" ;
$private_key = "9283c835ef5e21d3" ;
$gmt_datetime = "2018-11-30T20:04Z" ;
// e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
echo HMAC_SHA256 ( $private_key , $public_key , $gmt_datetime );
Python
Python example.
# coding: utf8
import sys
import hmac
import hashlib
try :
def HMAC_SHA256 ( private_key = "" , message = "" , time = "" ):
message += ":"
if time :
message += str ( time )
else :
message += str ( datetime . datetime . utcnow (). strftime ( '%Y-%m-%dT%H:%MZ' ))
return hmac . new ( str . encode ( private_key ), str . encode ( message ), hashlib . sha256 ). hexdigest ()
public_key = "ae7b4635320411fe"
private_key = "9283c835ef5e21d3"
gmt_datetime = "2018-11-30T20:04Z"
# e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
print ( HMAC_SHA256 ( private_key , public_key , gmt_datetime ))
except Exception as t :
print ( t )
sys . exit ( 0 )
# end try
NodeJS
NodeJS example.
const crypto = require ( ' crypto ' );
try {
function gmdate () {
var iso = ( new Date ()). toISOString ();
return iso . substr ( 0 , iso . length - 8 ) + ' Z ' ;
}
function create_sha256 ( key , message ) {
var hmac = crypto . createHmac ( ' sha256 ' , key );
hmac . update ( message );
return hmac . digest ( ' hex ' );
}
function HMAC_SHA256 ( private_key , message , time ) {
var msg = message + " : " + ( time ? time : gmdate ());
return create_sha256 ( private_key , msg );
}
var public_key = " ae7b4635320411fe " ;
var private_key = " 9283c835ef5e21d3 " ;
var gmt_datetime = " 2018-11-30T20:04Z " ;
// e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
console . log ( HMAC_SHA256 ( private_key , public_key , gmt_datetime ));
} catch ( e ) {
console . log ( e . message );
}
Java
Java example.
import javax.crypto.Mac ;
import javax.crypto.spec.SecretKeySpec ;
import java.security.NoSuchAlgorithmException ;
import java.security.InvalidKeyException ;
import java.text.SimpleDateFormat ;
import java.util.Locale ;
import java.util.Date ;
import java.util.TimeZone ;
public class HMAC_SHA256_EXAMPLE {
public static String gmdate () {
String pattern = "yyy-MM-dd'T'HH:mm'Z'" ;
SimpleDateFormat simpleDateFormat = new SimpleDateFormat ( pattern );
simpleDateFormat . setTimeZone ( TimeZone . getTimeZone ( "UTC" ));
return simpleDateFormat . format ( new Date ());
}
public static String hex ( byte [] bytes ) {
StringBuilder result = new StringBuilder ();
for ( byte aByte: bytes ) {
result . append ( String . format ( "%02x" , aByte ));
}
return result . toString ();
}
public static String HMAC_SHA256 ( String private_key , String message , String date_time )
throws NoSuchAlgorithmException , InvalidKeyException {
Mac sha256_HMAC = Mac . getInstanceNumber ( "HmacSHA256" );
SecretKeySpec secret_key = new SecretKeySpec ( private_key . getBytes (), "HmacSHA256" );
sha256_HMAC . initClient ( secret_key );
return hex ( sha256_HMAC . doFinal (( message + ":" + date_time ). getBytes ()));
}
public static String HMAC_SHA256 ( String private_key , String message )
throws NoSuchAlgorithmException , InvalidKeyException {
return HMAC_SHA256 ( private_key , message , gmdate ());
}
public static void main ( String [] args ) {
try {
String public_key = "ae7b4635320411fe" ;
String private_key = "9283c835ef5e21d3" ;
String date_time = "2018-11-30T20:04Z" ;
// e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
System . out . println ( HMAC_SHA256 ( private_key , public_key , date_time ));
}
catch ( Exception e ) {
System . out . println ( "Error" );
}
}
}
C#
C# example.
using System ;
using System.Security.Cryptography ;
using System.Text ;
namespace HMAC_SHA256_EXAMPLE
{
class Program
{
public static string gmdate ()
{
return DateTime . UtcNow . ToString ( "yyyy-MM-ddTHH:mmZ" );
}
public static string hex ( byte [] ba )
{
StringBuilder hex = new StringBuilder ( ba . Length * 2 );
foreach ( byte b in ba )
{
hex . AppendFormat ( "{0:x2}" , b );
}
return hex . ToString ();
}
private static string HMAC_SHA256 ( string private_key , string message , string time = "" )
{
var hash = new HMACSHA256 ( Encoding . ASCII . GetBytes ( private_key ));
return hex ( hash . ComputeHash ( Encoding . ASCII . GetBytes ( message + ":" + ( time ?? gmdate ()))));
}
static void Main ( string [] args )
{
var public_key = "ae7b4635320411fe" ;
var private_key = "9283c835ef5e21d3" ;
var gmt_datetime = "2018-11-30T20:04Z" ;
// e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
Console . WriteLine ( HMAC_SHA256 ( private_key , public_key , gmt_datetime ));
}
}
}
Flutter (Dart)
Flutter (Dart) example.
import 'dart:convert' ;
import 'package:crypto/crypto.dart' ;
void main () {
String public_key = 'ae7b4635320411fe' ;
String private_key = '9283c835ef5e21d3' ;
String gmt_datetime = '2018-11-30T20:04Z' ;
// e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
print ( HMAC_SHA256 ( private_key , public_key , gmt_datetime ));
}
String gmdate () {
String iso = DateTime . now () . toUtc () . toIso8601String ();
return iso . substring ( 0 , 16 ) + 'Z' ;
}
String create_sha256 ( String key , String message ) {
var hmacSha256 = new Hmac ( sha256 , utf8 . encode ( key ));
var digest = hmacSha256 . convert ( utf8 . encode ( message ));
return digest . toString ();
}
String HMAC_SHA256 ( String private_key , String message , [ String time = '' ]) {
String msg = message + ":" + ( ! time . isEmpty ? time : gmdate ());
return create_sha256 ( private_key , msg );
}
Token authentication
Token authentication (also called bearer authentication) is an HTTP authentication scheme that involves security tokens
called bearer tokens.
Step 1: acquiring a token
Request
https://joturl.com/a/i1/apis/tokens
The above request returns a JSON structured like this:
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
},
"result" : {
"read_write_token" : "tok_RWxtd74zqlcv18d6qiau75kr1bwpagqbq5" ,
"read_only_token" : "tok_RO064cmpvzcsxc5ufg0xzx58ms3q15bn10"
}
}
API tokens authentication needs a read-only or read/write token that is used to sign all other request to the API endpoints.
API tokens do not expire and can be reset using the endpoint apis/tokens .
To get API tokens you have to make a request (GET
or POST
) to the endpoint:
https://joturl.com/a/i1/users/tokens
you must already be logged in using the session token .
Step 2: sign API calls
Every request to API endpoints have to be signed with the Authorization
HTTP header:
Authorization: Bearer {token}
where {token}
is one of the API tokens obtained in step 1.
With the read-only token you can only call endpoints with access [read] .
You can find the required access of each endpoint immediately below the endpoint itself in this documentation.
Example
https://joturl.com/a/i1/urls/shorten?long_url=https%3A%2F%2Fwww.joturl.com%2F&alias=jot
Parameters to each JotUrl API can be passed both with the GET and POST methods.
Query
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 87
},
"result" : { DATA }
}
Query
format=jsonp&callback=clbfunc
Response
clbfunc ({
" status " : {
" code " : 200 ,
" text " : " OK " ,
" error " : "" ,
" rate " : 87
},
" result " : { DATA }
})
Query
Response
{
"status" : {
"code" : 500 ,
"text" : "MISSING callback" ,
"error" : "" ,
"rate" : 21
},
"result" : []
}
Query
Response
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>
<code> 200</code>
<text> OK</text>
<error></error>
<rate> 87</rate>
</status>
<result> {DATA}</result>
</response>
Query
Response
status_code=200
status_text=OK
status_error=
status_rate=87
result={DATA}
Query
Response
The JotUrl API supports Cross Origin Resource Sharing (CORS ) requests from any domain.
All JotUrl APIs support five return formats: json
, jsonp
, xml
, txt
, plain
. Note that the formats txt
and plain
may return only limited information.
The default output format is format = json
that is also used when the parameter format is invalid (e.g., format = jsonp
but no callback parameter is specified).
In cases format = json
and format = jsonp
, when a method returns an empty object, it returns an empty JSON array (i.e., []
), if you want to
change this behavior pass the header force-empty-objects: 1
in the request, this forces an empty JSON object (i.e., {}
) instead.
When format = plain
, check the HTTP response status for problems with the request, rate limiting, or other errors.
Rate limits
If the rate limits are exceeded, the call fails and returns a 403 status code, with a LIMIT EXCEEDED status text (see Output formats for details).
Typical response
{
"status" : {
"code" : <STATUS CODE> ,
"text" : "<STATUS TEXT>" ,
"error" : "<STATUS ERROR>" ,
"rate" : <REQUESTS PER SECOND>
},
"result" : <DATA>
}
If you send requests too quickly, make sure that the rate
parameter in the status
response is below the rate limits
set for your account. The rate
parameter is always expressed in requests per second. If you exceed the limits set for
your account, our engine may block your requests for a time directly proportional to the speed with which you are
sending the requests: the greater the gap with your rate limits, the greater the blocking time. Finally, if you do not
fall within your rate limits for a long time, our engine could permanently block any further requests.
QR-Codes
A QR-Code is provided for each shorten URL. To generate it append .qrcode
or .qr
to the end of any shortened link. For example: http://jo.my/jotvideo.qrcode
, http://jo.my/jotvideo.qr
Errors
For each request the status code is equal to the HTTP response status that can be:
code
text
error
explanation
200
OK
successful request
403
LIMIT EXCEEDED
details on the error if available
rate limit exceeded
404
NOT FOUND
details on the error if available
the query is well-formed but there is no available response
405
METHOD NOT ALLOWED
details on the error if available
the endpoint is not available to the calling user
414
Request-URI Too Large
details on the error if available
GET request contains long query information, use a POST request instead
500
INVALID [PARAMETER]
details on the error if available
invalid parameter [PARAMETER] in the request
INVALID METHOD [METHOD]
details on the error if available
invalid method [METHOD]
MISSING [ARGUMENT]
details on the error if available
the required argument [ARGUMENT] is missing in the request
503
GENERIC ERROR
details on the error if available
a generic error occurred and/or the service is temporarily unavailable 1
1 A GENERIC ERROR
(503) is also issued in all those cases where a parameter has passed all
validation checks, but for some reason our engine cannot use it to complete the request. For example, if you try to
create a tracking link with the alias $alias
you will see the error INVALID alias
(500), since
the alias $alias
contains the forbidden character $
, but if you try to create a tracking link with the alias alias
and it is already
have been used, you will see the error GENERIC ERROR
(503) and the error
field of the output status
will be "The chosen alias is not available".
Parameters types
API endpoints require some parameters to be sent as part of the request.
Most parameters are simple strings, but some endpoints require other types to be provided.
type
description
example
string
sequence of alphanumeric text or other symbols
hamburger
id
variable length string obtained as a result of an API call
62613864764b3762725a343966673d3d
array
comma separated list of type string , a maximum of 100 items are allowed
hamburger, test
array_of_ids
comma separated list of type id , a maximum of 100 items are allowed
62613864764b375a343966673d3d, 86590152f1891e680, 5952b26623c9b47ad9e
integer
integer
12
float
float with . (point) as a decimal separator
12.34
boolean
boolean parameter, accepted values are true , false , on , off , 1 , 0
1
date
date in the format yyyy-mm-dd (UTC)
2019-06-04
datetime
date/time in the format yyyy-mm-dd hh:mm:ss (UTC)
2019-06-04 19:21:34
json
stringified JSON object or associative array
{"test":"check"}, param[test]=check
enum
is a string with a value chosen from a list of allowed values
remarketing
JotUrl SDKs
JotUrl SDKs help you develop apps, websites and plugins that relies on all the functionality of our APIs.
We currently support PHP, Python, Java and NodeJS, but you can easily integrate our APIs with all development technologies.
PHP SDK
Click here to download the SDK for PHP with an example included.
PHP example
<?php
// replace [your login] with the email you use to login into JotUrl
define ( 'SDK_USER_NAME' , '[your login]' );
// replace [public key] with your public key: https://www.joturl.com/reserved/settings.html#tools-api
define ( 'SDK_PUBLIC_API_KEY' , '[public key]' );
// replace [private key] with your private key: https://www.joturl.com/reserved/settings.html#tools-api
define ( 'SDK_PRIVATE_API_KEY' , '[private key]' );
require_once 'sdk/JotUrlSDK.php' ;
try {
// create an instance of JotUrlSDK
$joturl = new JotUrlSDK ( SDK_USER_NAME , SDK_PUBLIC_API_KEY , SDK_PRIVATE_API_KEY );
$joturl -> wrapper ( function ( $sdk ) {
// get logged user information
$url = $sdk -> buildURL ( 'users/info' );
echo "Getting user info" . PHP_EOL ;
$result = $sdk -> call ( $url );
echo "====== USER INFO ======" . PHP_EOL ;
print_r ( $result );
} );
$joturl -> wrapper ( function ( $sdk ) {
// get first 5 projects
$url = $sdk -> buildURL ( 'projects/list' , array ( "fields" => "id,name" , "length" => 5 ) );
echo "Getting first 5 projects (if available)" . PHP_EOL ;
$result = $sdk -> call ( $url );
echo "====== PROJECTS ======" . PHP_EOL ;
print_r ( $result );
} );
} catch ( Throwable $t ) {
die ( $t -> getMessage () );
}
Documentation
<?php
/**
* Creates an instance of the JotUrl SDK.
*
* @param string $username the username used to login into JotURL dashboard
* @param string $public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
* @param string $private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
*/
new JotUrlSDK ( $username , $public_key , $private_key );
/**
* Automatically try to access the JotURL API, the callback is called if the access is successful.
*
* @param mixed $callback callback to be called on success
*
* @return mixed value returned by the $callback function, an exception is thrown on error
*/
function wrapper ( $callback );
/**
* Given an endpoint and parameters (optional) returns the URL to be called.
*
* @param string $endpoint endpoint to be called
* @param array $parameters associative array [param => value]
*
* @return string the URL to be called
*/
function buildURL ( $endpoint , $parameters = array () );
/**
* Call and get results from the API endpoint.
*
* @param string $url URL to be called
* @param array $postParameters [OPTIONAL] array containing post parameters
*
* @return bool|array associative array containing the result of the call
*/
function call ( $url , $postParameters = array () );
Python SDK
Click here to download the SDK for Python 3+ with an example included.
Python example
# coding: utf8
import sys
from sdk.JotUrlSDK import JotUrlSDK
# replace [your login] with the email you use to login into JotUrl
SDK_USER_NAME = "[your login]"
# replace [public key] with your public key: https://www.joturl.com/reserved/settings.html#tools-api
SDK_PUBLIC_API_KEY = "[public key]"
# replace [private key] with your private key: https://www.joturl.com/reserved/settings.html#tools-api
SDK_PRIVATE_API_KEY = "[private key]"
try :
# create an instance of JotUrlSDK
joturl = JotUrlSDK ( SDK_USER_NAME , SDK_PUBLIC_API_KEY , SDK_PRIVATE_API_KEY )
def getUserInfo ( sdk ):
# get logged user information
url = sdk . buildURL ( "users/info" )
print ( "Getting user info" )
result = sdk . call ( url )
print ( "====== USER INFO ======" )
print ( result )
joturl . wrapper ( getUserInfo )
def getProjectsList ( sdk ):
# get first 5 projects
url = sdk . buildURL ( "projects/list" , { "fields" : "id,name" , "length" : 5 })
print ( "Getting first 5 projects (if available)" )
result = sdk . call ( url )
print ( "====== PROJECTS ======" )
print ( result )
joturl . wrapper ( getProjectsList )
def getProjectsListWithPOSTRequest ( sdk ):
# get first 5 projects
url = sdk . buildURL ( "projects/list" )
print ( "Getting first 5 projects (if available) with a POST request" )
result = sdk . call ( url , { "fields" : "id,name" , "length" : 5 })
print ( "====== PROJECTS ======" )
print ( result )
joturl . wrapper ( getProjectsListWithPOSTRequest )
except Exception as t :
print ( t )
sys . exit ( 0 )
# end try
Documentation
"""
Creates an instance of the JotUrl SDK.
@param username the username used to login into JotURL dashboard
@param public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
@param private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
"""
def __init__ ( self , username = "" , public_key = "" , private_key = "" ):
"""
Automatically try to access the JotURL API, the callback is called if the access is successful.
@param callback callback to be called on success
returns True on success, raises an exception on error
"""
def wrapper ( self , callback = None ):
"""
Given an endpoint and parameters (optional) returns the URL to be called.
@param endpoint endpoint to be called
@param parameters associative array [param => value]
returns the URL to be called
"""
def buildURL ( self , endpoint = "" , parameters = {}):
"""
Call and get results from the API endpoint.
@param url URL to be called
@param postParameters [OPTIONAL] array containing post parameters
returns bool|array JSON containing the result of the call, false on failure, raises an exception on error
"""
def call ( self , url = "" , postParameters = {}):
NodeJS SDK
Click here to download the SDK for NodeJS with an example included.
NodeJS example
// replace [your login] with the email you use to login into JotUrl
const SDK_USER_NAME = ' [your login] ' ;
// replace [public key] with your public key: https://www.joturl.com/reserved/settings.html#tools-api
const SDK_PUBLIC_API_KEY = ' [public key] ' ;
// replace [private key] with your private key: https://www.joturl.com/reserved/settings.html#tools-api
const SDK_PRIVATE_API_KEY = ' [private key] ' ;
try {
// create an instance of JotUrlSDK
let joturl = require ( ' ./sdk/JotUrlSDK.js ' )( SDK_USER_NAME , SDK_PUBLIC_API_KEY , SDK_PRIVATE_API_KEY );
// get logged user information
console . log ( " Getting user info " );
joturl . call ( ' users/info ' ). then ( result => {
console . log ( result );
/* get first 5 projects */
console . log ( " Getting first 5 projects (if available) " );
joturl . call ( ' projects/list ' , { " fields " : " id,name " , " length " : 5 }). then ( result => {
console . log ( result );
}). catch ( e => {
console . log ( e . message );
});
}). catch ( e => {
console . log ( e . message );
});
} catch ( e ) {
console . log ( e . message );
}
Documentation
/**
* Creates an instance of the JotUrl SDK.
*
* @param _username the username used to login into JotURL dashboard
* @param _public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
* @param _private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
* @param base_url the base URL to be use to call API endpoints, defaults to https://joturl.com/a/i1/
*
* @returns {JotUrlSDK}
*/
require ( ' JotUrlSDK ' )( _username , _public_key , _private_key , base_url );
/**
* Call and get results from the API endpoint.
*
* @param endpoint API endpoint to be called
* @param parameters [OPTIONAL] parameters to be passed to the call
* @param postParameters [OPTIONAL] post parameters to be passed to the call
*
* @returns {Promise}
*/
function call ( endpoint , parameters = {}, postParameters = {});
Java SDK
Click here to download the SDK for Java with an example included.
Java example
import joturlsdk.JotUrlRunnable ;
import joturlsdk.JotUrlSDK ;
public class JotUrlExample {
public static void main ( String [] args ) {
try {
JotUrlSDK sdk = new JotUrlSDK ( "[username]" , "[public_key]" , "[private_key]" );
sdk . call ( "users/info" , new JotUrlRunnable () {
public void run () {
System . out . println ( this . result );
}
});
} catch ( Exception e ) {
System . out . println ( "Error: " + e . getMessage ());
}
}
}
Documentation
/**
* Creates an instance of the JotUrl SDK.
*
* @param _username the username used to login into JotURL dashboard
* @param _public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
* @param _private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
*
* @returns {JotUrlSDK}
*/
JotUrlSDK sdk = new JotUrlSDK ( _username , _public_key , _private_key );
/**
* Call and get results from the API endpoint.
*
* @param endpoint API endpoint to be called
* @param parameters parameters to be passed to the call (null to ignore)
* @param postParameters post parametersto be passed to the call (null to ignore)
*
*/
JotUrlSDK . call ( String endpoint , JotUrlRunnable callback , Map < String , String > parameters , Map < String , String > postParameters );
JotUrlSDK . call ( String endpoint , JotUrlRunnable callback );
JotUrlSDK . callGET ( String endpoint , Map < String , String > parameters , JotUrlRunnable callback );
JotUrlSDK . callPOST ( String endpoint , Map < String , String > postParameters , JotUrlRunnable callback );
Flutter SDK
Click here to download the SDK for Flutter with an example included.
Dart example
import 'package:joturlsdk/joturlsdk.dart' ;
void main () async {
final String username = '[username]' ;
final String public_key = '[public_key]' ;
final String private_key = '[private_key]' ;
try {
JotUrlSDK sdk = new JotUrlSDK ( username , public_key , private_key );
dynamic result = await sdk . call ( "users/info" );
print ( 'result: ' + result . toString ());
} catch ( e ) {
print ( "Error: " + e . toString ());
}
}
Documentation
/**
* Creates an instance of the JotUrl SDK.
*
* @param _username the username used to login into JotURL dashboard
* @param _public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
* @param _private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
* @param base_url the base URL to be use to call API endpoints, defaults to https://joturl.com/a/i1/
*
* @returns JotUrlSDK
* @constructor
*/
JotUrlSDK sdk = new JotUrlSDK ( _username , _public_key , _private_key );
/**
* Call and get results from the API endpoint.
*
* @param endpoint API endpoint to be called
* @param getParameters query parameters to be passed to the call (null to ignore)
* @param postParameters post parametersto be passed to the call (null to ignore)
*
*/
sdk . call ( endpoint , { Map < String , dynamic > getParameters = null , Map < String , dynamic > postParameters = null });
API reference /decode
access: [READ]
This method converts API error codes into a friendly text message (in the current user language).
Example 1 (json)
Request
https://joturl.com/a/i1/decode?code=10
Query parameters
code = 10
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"message" : "An error occurred while deleting the QR codes of a URL"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/decode?code=10&format=xml
Query parameters
code = 10
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<message> An error occurred while deleting the QR codes of a URL </message>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/decode?code=10&format=txt
Query parameters
code = 10
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_message = An error occurred while deleting the QR codes of a URL
Example 4 (plain)
Request
https://joturl.com/a/i1/decode?code=10&format=plain
Query parameters
code = 10
format = plain
Response
An error occurred while deleting the QR codes of a URL
Required parameters
parameter
description
codeSTRING
numeric code representing the error message
Return values
parameter
description
lang
language in which the message is
message
decoded text message
/timestamp
access: [READ]
This method returns the current server timestamp (UTC) with microseconds as float.
Example 1 (json)
Request
https://joturl.com/a/i1/timestamp
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"timestamp" : 1737311492.082
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/timestamp?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<timestamp> 1737311492.082 </timestamp>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/timestamp?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_timestamp = 1737311492.082
Example 4 (plain)
Request
https://joturl.com/a/i1/timestamp?format=plain
Query parameters
format = plain
Response
1737311492.082
Return values
parameter
description
timestamp
the current Unix timestamp with microseconds
/translate
access: [READ]
This method translates an error codes into a friendly text message.
Example 1 (json)
Request
https://joturl.com/a/i1/translate?code=sample_message&lang=en
Query parameters
code = sample_message
lang = en
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"text" : "This is a sample error message" ,
"lang" : "en"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/translate?code=sample_message&lang=en&format=xml
Query parameters
code = sample_message
lang = en
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<text> This is a sample error message </text>
<lang> en </lang>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/translate?code=sample_message&lang=en&format=txt
Query parameters
code = sample_message
lang = en
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_text = This is a sample error message
result_lang = en
Example 4 (plain)
Request
https://joturl.com/a/i1/translate?code=sample_message&lang=en&format=plain
Query parameters
code = sample_message
lang = en
format = plain
Response
This is a sample error message
en
Required parameters
parameter
description
codeSTRING
string code representing the error message
Optional parameters
parameter
description
langSTRING
language in which you want to translate the message
Return values
parameter
description
lang
language in which the message is
text
text message corresponding to code
/apis /apis/accepted
access: [WRITE]
This method returns the actual result from an accepted (202) API endpoint.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/accepted
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : []
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/accepted?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/accepted?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result =
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/accepted?format=plain
Query parameters
format = plain
Response
Example 5 (json)
Request
https://joturl.com/a/i1/apis/accepted?_accepted_id=36749c48534f5e1b0208a9a4a05746f1
Query parameters
_accepted_id = 36749c48534f5e1b0208a9a4a05746f1
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"_accepted_id" : "36749c48534f5e1b0208a9a4a05746f1" ,
"_accepted_key" : "method_id" ,
"_accepted_perc" : 0 ,
"_accepted_count" : 0 ,
"_accepted_total" : 0 ,
"_accepted_errors" : 0 ,
"_accepted_dt" : "2025-01-19 18:31:31"
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/apis/accepted?_accepted_id=36749c48534f5e1b0208a9a4a05746f1&format=xml
Query parameters
_accepted_id = 36749c48534f5e1b0208a9a4a05746f1
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<_accepted_id> 36749c48534f5e1b0208a9a4a05746f1 </_accepted_id>
<_accepted_key> method_id </_accepted_key>
<_accepted_perc> 0 </_accepted_perc>
<_accepted_count> 0 </_accepted_count>
<_accepted_total> 0 </_accepted_total>
<_accepted_errors> 0 </_accepted_errors>
<_accepted_dt> 2025-01-19 18:31:31 </_accepted_dt>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/apis/accepted?_accepted_id=36749c48534f5e1b0208a9a4a05746f1&format=txt
Query parameters
_accepted_id = 36749c48534f5e1b0208a9a4a05746f1
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result__accepted_id = 36749c48534f5e1b0208a9a4a05746f1
result__accepted_key = method_id
result__accepted_perc = 0
result__accepted_count = 0
result__accepted_total = 0
result__accepted_errors = 0
result__accepted_dt = 2025-01-19 18:31:31
Example 8 (plain)
Request
https://joturl.com/a/i1/apis/accepted?_accepted_id=36749c48534f5e1b0208a9a4a05746f1&format=plain
Query parameters
_accepted_id = 36749c48534f5e1b0208a9a4a05746f1
format = plain
Response
36749c48534f5e1b0208a9a4a05746f1
method_id
0
0
0
0
2025-01-19 18:31:31
Optional parameters
parameter
description
_accepted_idID
ID returned by the accepted (202) API endpoint
stop_taskBOOLEAN
1 to stop the background task, _accepted_id is mandatory if stop_task is 1
Return values
parameter
description
_accepted_count
[OPTIONAL] completed subtasks (e.g., the number of imported tracking links)
_accepted_dt
[OPTIONAL] starting date/time of the task
_accepted_errors
[OPTIONAL] total number of subtasks not completed correctly (e.g., the number of tracking links for which the import has failed)
_accepted_id
[OPTIONAL] ID of the task started by the accepted (202) API endpoint
_accepted_key
[OPTIONAL] key that uniquely identifies the accepted (202) API endpoint that started the task
_accepted_perc
[OPTIONAL] percentage of completition of the task
_accepted_total
[OPTIONAL] total number of subtasks (e.g., the total number of tracking links to be imported)
data
[OPTIONAL] data returned at the end of the task from the accepted (202) API endpoint
stopped
[OPTIONAL] 1 if the task has been stopped, 0 otherwise, returned only if stop_task is 1
/apis/has_access
access: [READ]
User permissions can remove access to this version of the API. This method returns 1 only if the user has access to this version of the API.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/has_access
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"has_access" : 0
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/has_access?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<has_access> 0 </has_access>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/has_access?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_has_access = 0
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/has_access?format=plain
Query parameters
format = plain
Response
0
Return values
parameter
description
has_access
1 if the user has access to this API version, 0 otherwise
/apis/keys
access: [WRITE]
This method returns the API keys associated to the logged in user.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/keys
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"public" : "ddac90b80bc320078a211dd8d46ce3c8" ,
"private" : "9519bf7bac451b4049efe767aea735d9"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/keys?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<public> ddac90b80bc320078a211dd8d46ce3c8 </public>
<private> 9519bf7bac451b4049efe767aea735d9 </private>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/keys?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_public = ddac90b80bc320078a211dd8d46ce3c8
result_private = 9519bf7bac451b4049efe767aea735d9
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/keys?format=plain
Query parameters
format = plain
Response
ddac90b80bc320078a211dd8d46ce3c8
9519bf7bac451b4049efe767aea735d9
Example 5 (json)
Request
https://joturl.com/a/i1/apis/keys?password=e9np9icphc&reset=1
Query parameters
password = e9np9icphc
reset = 1
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"public" : "f4569f7f0c2283f295e100e255f4b511" ,
"private" : "b4767c2d4d6ee7f1d0371084ff601871"
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/apis/keys?password=e9np9icphc&reset=1&format=xml
Query parameters
password = e9np9icphc
reset = 1
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<public> f4569f7f0c2283f295e100e255f4b511 </public>
<private> b4767c2d4d6ee7f1d0371084ff601871 </private>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/apis/keys?password=e9np9icphc&reset=1&format=txt
Query parameters
password = e9np9icphc
reset = 1
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_public = f4569f7f0c2283f295e100e255f4b511
result_private = b4767c2d4d6ee7f1d0371084ff601871
Example 8 (plain)
Request
https://joturl.com/a/i1/apis/keys?password=e9np9icphc&reset=1&format=plain
Query parameters
password = e9np9icphc
reset = 1
format = plain
Response
f4569f7f0c2283f295e100e255f4b511
b4767c2d4d6ee7f1d0371084ff601871
Optional parameters
parameter
description
passwordSTRING
current account password, to be sent if reset = 1
resetBOOLEAN
1 to reset API keys, if this parameter is 1 the POST method is required (because the password is sent)
Return values
parameter
description
private
the user private API key
public
the user public API key
/apis/lab /apis/lab/add
access: [WRITE]
This method adds a new LAB script.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B
Query parameters
name = test script
script = LogManager.log('script');
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"name" : "test script" ,
"script" : "LogManager.log('script');" ,
"id" : "4f54cd183e547e3b276de09b9257c3db" ,
"creation" : "2025-01-19 18:31:31"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B&format=xml
Query parameters
name = test script
script = LogManager.log('script');
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<name> test script </name>
<script> LogManager.log('script'); </script>
<id> 4f54cd183e547e3b276de09b9257c3db </id>
<creation> 2025-01-19 18:31:31 </creation>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B&format=txt
Query parameters
name = test script
script = LogManager.log('script');
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_name = test script
result_script = LogManager.log('script');
result_id = 4f54cd183e547e3b276de09b9257c3db
result_creation = 2025-01-19 18:31:31
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B&format=plain
Query parameters
name = test script
script = LogManager.log('script');
format = plain
Response
test script
LogManager.log('script');
4f54cd183e547e3b276de09b9257c3db
2025-01-19 18:31:31
Required parameters
parameter
description
nameSTRING
LAB script name
scriptHTML
LAB script content
We suggest that you call this endpoint using the POST method due to the large number of characters that may be required in script
.
Return values
parameter
description
creation
creation date/time of the LAB script
id
ID of the LAB script
name
LAB script name (max length: 100000 bytes)
/apis/lab/count
access: [READ]
This method returns the number of LAB scripts.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/lab/count?search=a
Query parameters
search = a
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/lab/count?search=a&format=xml
Query parameters
search = a
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 1 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/lab/count?search=a&format=txt
Query parameters
search = a
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/lab/count?search=a&format=plain
Query parameters
search = a
format = plain
Response
1
Example 5 (json)
Request
https://joturl.com/a/i1/apis/lab/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 57
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/apis/lab/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 57 </count>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/apis/lab/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 57
Example 8 (plain)
Request
https://joturl.com/a/i1/apis/lab/count?format=plain
Query parameters
format = plain
Response
57
Optional parameters
parameter
description
searchSTRING
filter LAB scripts by searching them
Return values
parameter
description
count
total number of LAB scripts, filtered by search : if passed
/apis/lab/delete
access: [WRITE]
This method deletes LAB scripts by using the parameter ids .
Example 1 (json)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
Query parameters
ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"deleted" : 2
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f&format=xml
Query parameters
ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<deleted> 2 </deleted>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f&format=txt
Query parameters
ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_deleted = 2
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f&format=plain
Query parameters
ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
format = plain
Response
2
Example 5 (json)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
Query parameters
ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"ids" : "18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df" ,
"deleted" : 1
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df&format=xml
Query parameters
ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<ids> 18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df </ids>
<deleted> 1 </deleted>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df&format=txt
Query parameters
ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_ids = 18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
result_deleted = 1
Example 8 (plain)
Request
https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df&format=plain
Query parameters
ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
format = plain
Response
18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
1
Required parameters
parameter
description
idsARRAY_OF_IDS
comma-separated list of LAB script IDs to be deleted, max number of IDs in the list: 100
Return values
parameter
description
deleted
number of deleted scripts
/apis/lab/edit
access: [WRITE]
This method edits a LAB script.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/lab/edit?id=d7858f992333e201d12b81dae5c93ff3&name=test+script
Query parameters
id = d7858f992333e201d12b81dae5c93ff3
name = test script
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "d7858f992333e201d12b81dae5c93ff3" ,
"name" : "test script" ,
"updated" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/lab/edit?id=d7858f992333e201d12b81dae5c93ff3&name=test+script&format=xml
Query parameters
id = d7858f992333e201d12b81dae5c93ff3
name = test script
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> d7858f992333e201d12b81dae5c93ff3 </id>
<name> test script </name>
<updated> 1 </updated>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/lab/edit?id=d7858f992333e201d12b81dae5c93ff3&name=test+script&format=txt
Query parameters
id = d7858f992333e201d12b81dae5c93ff3
name = test script
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = d7858f992333e201d12b81dae5c93ff3
result_name = test script
result_updated = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/lab/edit?id=d7858f992333e201d12b81dae5c93ff3&name=test+script&format=plain
Query parameters
id = d7858f992333e201d12b81dae5c93ff3
name = test script
format = plain
Response
d7858f992333e201d12b81dae5c93ff3
test script
1
Required parameters
parameter
description
idID
ID of the LAB script to edit
Optional parameters
parameter
description
nameSTRING
LAB script name
scriptHTML
content of the LAB script
If script
is passed, we suggest that you call this endpoint using the POST method due to the large number of characters that may be required in script
. One of the parameters name
and script
is mandatory
Return values
parameter
description
updated
1 on success, 0 otherwise
/apis/lab/info
access: [READ]
This method returns info about a LAB script.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/lab/info
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : [
{
"id" : "827dd3604798500a552e723b6c8654a5" ,
"name" : "script name 0" ,
"creation" : "2025-01-19 18:43:51" ,
"script" : "LogManager.log('script 0');"
} ,
{
"id" : "9c87daaaba099e52e61414424ee82235" ,
"name" : "script name 1" ,
"creation" : "2025-01-19 18:46:59" ,
"script" : "LogManager.log('script 1');"
} ,
{
"id" : "29417f7108f9e2b7c3d0fd99b1fe5a5d" ,
"name" : "script name 2" ,
"creation" : "2025-01-19 18:58:59" ,
"script" : "LogManager.log('script 2');"
} ,
{
"id" : "7c7043ea328b0182e4f5e43f265bc210" ,
"name" : "script name 3" ,
"creation" : "2025-01-19 21:17:14" ,
"script" : "LogManager.log('script 3');"
} ,
{
"id" : "369e52829b4f147a629f7f9633d7eb76" ,
"name" : "script name 4" ,
"creation" : "2025-01-19 22:27:30" ,
"script" : "LogManager.log('script 4');"
}
]
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/lab/info?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<i0>
<id> 827dd3604798500a552e723b6c8654a5 </id>
<name> script name 0 </name>
<creation> 2025-01-19 18:43:51 </creation>
<script> LogManager.log('script 0'); </script>
</i0>
<i1>
<id> 9c87daaaba099e52e61414424ee82235 </id>
<name> script name 1 </name>
<creation> 2025-01-19 18:46:59 </creation>
<script> LogManager.log('script 1'); </script>
</i1>
<i2>
<id> 29417f7108f9e2b7c3d0fd99b1fe5a5d </id>
<name> script name 2 </name>
<creation> 2025-01-19 18:58:59 </creation>
<script> LogManager.log('script 2'); </script>
</i2>
<i3>
<id> 7c7043ea328b0182e4f5e43f265bc210 </id>
<name> script name 3 </name>
<creation> 2025-01-19 21:17:14 </creation>
<script> LogManager.log('script 3'); </script>
</i3>
<i4>
<id> 369e52829b4f147a629f7f9633d7eb76 </id>
<name> script name 4 </name>
<creation> 2025-01-19 22:27:30 </creation>
<script> LogManager.log('script 4'); </script>
</i4>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/lab/info?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_0_id = 827dd3604798500a552e723b6c8654a5
result_0_name = script name 0
result_0_creation = 2025-01-19 18:43:51
result_0_script = LogManager.log('script 0');
result_1_id = 9c87daaaba099e52e61414424ee82235
result_1_name = script name 1
result_1_creation = 2025-01-19 18:46:59
result_1_script = LogManager.log('script 1');
result_2_id = 29417f7108f9e2b7c3d0fd99b1fe5a5d
result_2_name = script name 2
result_2_creation = 2025-01-19 18:58:59
result_2_script = LogManager.log('script 2');
result_3_id = 7c7043ea328b0182e4f5e43f265bc210
result_3_name = script name 3
result_3_creation = 2025-01-19 21:17:14
result_3_script = LogManager.log('script 3');
result_4_id = 369e52829b4f147a629f7f9633d7eb76
result_4_name = script name 4
result_4_creation = 2025-01-19 22:27:30
result_4_script = LogManager.log('script 4');
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/lab/info?format=plain
Query parameters
format = plain
Response
827dd3604798500a552e723b6c8654a5
script name 0
2025-01-19 18:43:51
LogManager.log('script 0');
9c87daaaba099e52e61414424ee82235
script name 1
2025-01-19 18:46:59
LogManager.log('script 1');
29417f7108f9e2b7c3d0fd99b1fe5a5d
script name 2
2025-01-19 18:58:59
LogManager.log('script 2');
7c7043ea328b0182e4f5e43f265bc210
script name 3
2025-01-19 21:17:14
LogManager.log('script 3');
369e52829b4f147a629f7f9633d7eb76
script name 4
2025-01-19 22:27:30
LogManager.log('script 4');
Required parameters
parameter
description
idID
ID of the LAB script
Return values
parameter
description
creation
creation date/time of the LAB script
id
ID of the LAB script
name
name of the LAB script
script
content of the LAB script
/apis/lab/list
access: [READ]
This method returns a list of available custom scripts for the current user.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/lab/list
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : [
{
"id" : "84fbf6dbbeceb747375b3af1f726818f" ,
"name" : "script name 0" ,
"creation" : "2025-01-19 18:57:10"
} ,
{
"id" : "4490aa291fe80062338b2828f7ea45ea" ,
"name" : "script name 1" ,
"creation" : "2025-01-19 19:43:44"
} ,
{
"id" : "136e96fba9cf20d03a626e11dc05ecf8" ,
"name" : "script name 2" ,
"creation" : "2025-01-19 20:43:46"
} ,
{
"id" : "abab24c1e5c9358b7a1b8ee9d75a89c1" ,
"name" : "script name 3" ,
"creation" : "2025-01-19 22:53:25"
} ,
{
"id" : "07562aafebc44ad7342883b7a34e799c" ,
"name" : "script name 4" ,
"creation" : "2025-01-20 01:36:01"
}
]
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/lab/list?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<i0>
<id> 84fbf6dbbeceb747375b3af1f726818f </id>
<name> script name 0 </name>
<creation> 2025-01-19 18:57:10 </creation>
</i0>
<i1>
<id> 4490aa291fe80062338b2828f7ea45ea </id>
<name> script name 1 </name>
<creation> 2025-01-19 19:43:44 </creation>
</i1>
<i2>
<id> 136e96fba9cf20d03a626e11dc05ecf8 </id>
<name> script name 2 </name>
<creation> 2025-01-19 20:43:46 </creation>
</i2>
<i3>
<id> abab24c1e5c9358b7a1b8ee9d75a89c1 </id>
<name> script name 3 </name>
<creation> 2025-01-19 22:53:25 </creation>
</i3>
<i4>
<id> 07562aafebc44ad7342883b7a34e799c </id>
<name> script name 4 </name>
<creation> 2025-01-20 01:36:01 </creation>
</i4>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/lab/list?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_0_id = 84fbf6dbbeceb747375b3af1f726818f
result_0_name = script name 0
result_0_creation = 2025-01-19 18:57:10
result_1_id = 4490aa291fe80062338b2828f7ea45ea
result_1_name = script name 1
result_1_creation = 2025-01-19 19:43:44
result_2_id = 136e96fba9cf20d03a626e11dc05ecf8
result_2_name = script name 2
result_2_creation = 2025-01-19 20:43:46
result_3_id = abab24c1e5c9358b7a1b8ee9d75a89c1
result_3_name = script name 3
result_3_creation = 2025-01-19 22:53:25
result_4_id = 07562aafebc44ad7342883b7a34e799c
result_4_name = script name 4
result_4_creation = 2025-01-20 01:36:01
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/lab/list?format=plain
Query parameters
format = plain
Response
84fbf6dbbeceb747375b3af1f726818f
script name 0
2025-01-19 18:57:10
4490aa291fe80062338b2828f7ea45ea
script name 1
2025-01-19 19:43:44
136e96fba9cf20d03a626e11dc05ecf8
script name 2
2025-01-19 20:43:46
abab24c1e5c9358b7a1b8ee9d75a89c1
script name 3
2025-01-19 22:53:25
07562aafebc44ad7342883b7a34e799c
script name 4
2025-01-20 01:36:01
Optional parameters
parameter
description
searchSTRING
filters items to be extracted by searching them
Return values
parameter
description
count
total number of LAB scripts
data
list of available/filtered LAB scripts for the current user
/apis/limits
access: [READ]
This method returns the API limits for the logged user.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/limits
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"primary" : {
"limit" : 500 ,
"unit" : "HOUR"
} ,
"secondary" : {
"limit" : 50000 ,
"unit" : "DAY"
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/limits?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<primary>
<limit> 500 </limit>
<unit> HOUR </unit>
</primary>
<secondary>
<limit> 50000 </limit>
<unit> DAY </unit>
</secondary>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/limits?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_primary_limit = 500
result_primary_unit = HOUR
result_secondary_limit = 50000
result_secondary_unit = DAY
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/limits?format=plain
Query parameters
format = plain
Response
500
HOUR
50000
DAY
Return values
parameter
description
primary
object containing the primary rate limit: an integer limit and the unit in which the limit is expressed. unit is one of the following [MINUTE,HOUR,DAY,3_DAY]. 3_DAY is equivalent to 3 days
secondary
object containing the secondary rate limit: an integer limit and the unit in which the limit is expressed. unit is one of the following [MINUTE,HOUR,DAY,3_DAY]. 3_DAY is equivalent to 3 days
/apis/list
access: [READ]
This method returns the list of available versions of the API.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/list
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 2 ,
"data" : [
{
"id" : "v1" ,
"name" : "Version v1"
} ,
{
"id" : "i1" ,
"name" : "Version i1"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/list?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 2 </count>
<data>
<i0>
<id> v1 </id>
<name> Version v1 </name>
</i0>
<i1>
<id> i1 </id>
<name> Version i1 </name>
</i1>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/list?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 2
result_data_0_id = v1
result_data_0_name = Version v1
result_data_1_id = i1
result_data_1_name = Version i1
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/list?format=plain
Query parameters
format = plain
Response
2
v1
Version v1
i1
Version i1
Optional parameters
parameter
description
lengthINTEGER
extracts this number of items (maxmimum allowed: 100)
orderbyARRAY
orders items by field
searchSTRING
filters items to be extracted by searching them
sortSTRING
sorts items in ascending (ASC) or descending (DESC) order
startINTEGER
starts to extract items from this position
Return values
parameter
description
count
total number of versions
data
array containing required information on API versions the user has access to
/apis/tokens
access: [WRITE]
This method returns the API tokens associated to the logged in user.
Example 1 (json)
Request
https://joturl.com/a/i1/apis/tokens
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"read_write_token" : "tok_RW760c5a06080be447b1916b973e6f10b7" ,
"read_only_token" : "tok_ROd430631742eed8803784c1b2261b9254"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/apis/tokens?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<read_write_token> tok_RW760c5a06080be447b1916b973e6f10b7 </read_write_token>
<read_only_token> tok_ROd430631742eed8803784c1b2261b9254 </read_only_token>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/apis/tokens?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_read_write_token = tok_RW760c5a06080be447b1916b973e6f10b7
result_read_only_token = tok_ROd430631742eed8803784c1b2261b9254
Example 4 (plain)
Request
https://joturl.com/a/i1/apis/tokens?format=plain
Query parameters
format = plain
Response
tok_RW760c5a06080be447b1916b973e6f10b7
tok_ROd430631742eed8803784c1b2261b9254
Example 5 (json)
Request
https://joturl.com/a/i1/apis/tokens?password=e32cpgohmp&reset=1
Query parameters
password = e32cpgohmp
reset = 1
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"read_write_token" : "tok_RWa2ae6205ac3fbc5df3634fd27280ff08" ,
"read_only_token" : "tok_RO36a08a19a9df39e0db7c682a26cbc40a"
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/apis/tokens?password=e32cpgohmp&reset=1&format=xml
Query parameters
password = e32cpgohmp
reset = 1
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<read_write_token> tok_RWa2ae6205ac3fbc5df3634fd27280ff08 </read_write_token>
<read_only_token> tok_RO36a08a19a9df39e0db7c682a26cbc40a </read_only_token>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/apis/tokens?password=e32cpgohmp&reset=1&format=txt
Query parameters
password = e32cpgohmp
reset = 1
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_read_write_token = tok_RWa2ae6205ac3fbc5df3634fd27280ff08
result_read_only_token = tok_RO36a08a19a9df39e0db7c682a26cbc40a
Example 8 (plain)
Request
https://joturl.com/a/i1/apis/tokens?password=e32cpgohmp&reset=1&format=plain
Query parameters
password = e32cpgohmp
reset = 1
format = plain
Response
tok_RWa2ae6205ac3fbc5df3634fd27280ff08
tok_RO36a08a19a9df39e0db7c682a26cbc40a
Optional parameters
parameter
description
passwordSTRING
current account password, to be sent if reset = 1
resetBOOLEAN
1 to reset the API tokens, if this parameter is 1 the POST method is required (because the password is sent)
Return values
parameter
description
read_only_token
the read-only API access token
read_write_token
the read/write API access token
/cdns /cdns/add
access: [WRITE]
This method allows to upload a resource to the CDN.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D
Query parameters
type = image
info = {"name":"this is my resource"}
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "63eeeb6154e937efe50652e2d632113f" ,
"name" : "this is my resource" ,
"creation" : "2025-01-19 18:31:31" ,
"url" : "https:\/\/cdn.endpoint\/path\/to\/resource" ,
"width" : 533 ,
"height" : 400 ,
"size" : 20903 ,
"mime_type" : "image\/png"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&format=xml
Query parameters
type = image
info = {"name":"this is my resource"}
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 63eeeb6154e937efe50652e2d632113f </id>
<name> this is my resource </name>
<creation> 2025-01-19 18:31:31 </creation>
<url> https://cdn.endpoint/path/to/resource </url>
<width> 533 </width>
<height> 400 </height>
<size> 20903 </size>
<mime_type> image/png </mime_type>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&format=txt
Query parameters
type = image
info = {"name":"this is my resource"}
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 63eeeb6154e937efe50652e2d632113f
result_name = this is my resource
result_creation = 2025-01-19 18:31:31
result_url = https://cdn.endpoint/path/to/resource
result_width = 533
result_height = 400
result_size = 20903
result_mime_type = image/png
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&format=plain
Query parameters
type = image
info = {"name":"this is my resource"}
format = plain
Response
63eeeb6154e937efe50652e2d632113f
this is my resource
2025-01-19 18:31:31
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
Optional parameters
parameter
description
max length
external_urlURL
URL to an external resource (not managed by the CDN), this URL must be with HTTPS
4000
infoJSON
JSON containing additional info on the resource
inputSTRING
name of the HTML form field that contains data for the resource, if not passed the default value input will be used (i.e., input = input
)
The input
parameter must not be passed if the external_url
parameter is passed. Currently supported fields in info :
name : name of the resource, if not specified, the name of the file will be used.
NOTES : The parameter input contains the name of the field of the HTML form that is used to send resource data to this method. Form must have enctype = "multipart/form-data"
and method = "post"
.
<form
action= "/a/i1/cdns/add"
method= "post"
enctype= "multipart/form-data" >
<input name= "input" value= "resource_field" type= "hidden" />
[other form fields]
<input name= "resource_field" type= "file" />
</form>
Return values
parameter
description
creation
date/time when the CDN resource was created
height
height in pixels of the CDN resource, if available
id
ID of the CDN resource
mime_type
MIME type of the resource, or 'external_url' for external URLs
name
name of the CDN resource
size
size in bytes of the CDN resource, if available
url
URL of the CDN resource
width
width in pixels of the CDN resource, if available
/cdns/count
access: [READ]
This method returns the number of resources on the CDN.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 2
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 2 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 2
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/count?format=plain
Query parameters
format = plain
Response
2
Required parameters
Optional parameters
parameter
description
filtersJSON
filters to be used to count media, for available filters see i1/cdns/list
searchSTRING
filters CDN resources to be extracted by searching them
Return values
parameter
description
count
number of (filtered) CDN resources
/cdns/delete
access: [WRITE]
This method deletes a resource from the CDN.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/delete?id=1d36ceeeb85491ac76ba4dcb28ffd23c
Query parameters
id = 1d36ceeeb85491ac76ba4dcb28ffd23c
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "1d36ceeeb85491ac76ba4dcb28ffd23c" ,
"deleted" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/delete?id=1d36ceeeb85491ac76ba4dcb28ffd23c&format=xml
Query parameters
id = 1d36ceeeb85491ac76ba4dcb28ffd23c
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 1d36ceeeb85491ac76ba4dcb28ffd23c </id>
<deleted> 1 </deleted>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/delete?id=1d36ceeeb85491ac76ba4dcb28ffd23c&format=txt
Query parameters
id = 1d36ceeeb85491ac76ba4dcb28ffd23c
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 1d36ceeeb85491ac76ba4dcb28ffd23c
result_deleted = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/delete?id=1d36ceeeb85491ac76ba4dcb28ffd23c&format=plain
Query parameters
id = 1d36ceeeb85491ac76ba4dcb28ffd23c
format = plain
Response
1d36ceeeb85491ac76ba4dcb28ffd23c
1
Required parameters
parameter
description
idID
ID of the CDN resource to delete
Optional parameters
parameter
description
confirmBOOLEAN
If 1 this method deletes the CDN resource even if it is linked to a tracking link
Return values
parameter
description
deleted
1 if successful, otherwise a generic error message is issued
id
echo back of the id input parameter
/cdns/edit
access: [WRITE]
This method allows to modify a CDN resource.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=5cd6db510de5c18e5a100c8e30cc0750
Query parameters
type = image
info = {"name":"this is my resource"}
id = 5cd6db510de5c18e5a100c8e30cc0750
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "5cd6db510de5c18e5a100c8e30cc0750" ,
"name" : "this is my resource" ,
"creation" : "2025-01-19 18:31:31" ,
"url" : "https:\/\/cdn.endpoint\/path\/to\/resource" ,
"width" : 533 ,
"height" : 400 ,
"size" : 20903 ,
"mime_type" : "image\/png"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=5cd6db510de5c18e5a100c8e30cc0750&format=xml
Query parameters
type = image
info = {"name":"this is my resource"}
id = 5cd6db510de5c18e5a100c8e30cc0750
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 5cd6db510de5c18e5a100c8e30cc0750 </id>
<name> this is my resource </name>
<creation> 2025-01-19 18:31:31 </creation>
<url> https://cdn.endpoint/path/to/resource </url>
<width> 533 </width>
<height> 400 </height>
<size> 20903 </size>
<mime_type> image/png </mime_type>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=5cd6db510de5c18e5a100c8e30cc0750&format=txt
Query parameters
type = image
info = {"name":"this is my resource"}
id = 5cd6db510de5c18e5a100c8e30cc0750
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 5cd6db510de5c18e5a100c8e30cc0750
result_name = this is my resource
result_creation = 2025-01-19 18:31:31
result_url = https://cdn.endpoint/path/to/resource
result_width = 533
result_height = 400
result_size = 20903
result_mime_type = image/png
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=5cd6db510de5c18e5a100c8e30cc0750&format=plain
Query parameters
type = image
info = {"name":"this is my resource"}
id = 5cd6db510de5c18e5a100c8e30cc0750
format = plain
Response
5cd6db510de5c18e5a100c8e30cc0750
this is my resource
2025-01-19 18:31:31
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
Optional parameters
parameter
description
max length
external_urlURL
URL to an external resource (not managed by the CDN), this URL must be with HTTPS
4000
infoJSON
JSON containing additional info on the resource
inputSTRING
name of the HTML form field that contains data for the resource, if not passed the default value input will be used (i.e., input = input
)
The input
parameter must not be passed if the external_url
parameter is passed. Currently supported fields in info :
name : name of the resource, if not specified, the name of the file will be used.
NOTES : The parameter input contains the name of the field of the HTML form that is used to send resource data to this method. Form must have enctype = "multipart/form-data"
and method = "post"
.
<form
action= "/a/i1/cdns/edit"
method= "post"
enctype= "multipart/form-data" >
<input name= "input" value= "resource_field" type= "hidden" />
[other form fields]
<input name= "resource_field" type= "file" />
</form>
Return values
parameter
description
creation
date/time when the CDN resource was created
height
height in pixels of the CDN resource, if available
id
ID of the CDN resource
mime_type
MIME type of the resource, or 'external_url' for external URLs
name
name of the CDN resource
size
size in bytes of the CDN resource, if available
url
URL of the CDN resource
width
width in pixels of the CDN resource, if available
/cdns/info
access: [READ]
This method returns information about a resource on the CDN.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/info?id=31ddacd40e5b645adecb7ec308225113
Query parameters
id = 31ddacd40e5b645adecb7ec308225113
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : {
"id" : "31ddacd40e5b645adecb7ec308225113" ,
"name" : "this is my resource" ,
"creation" : "2019-06-25 13:01:23" ,
"url" : "https:\/\/cdn.endpoint\/path\/to\/resource" ,
"width" : 533 ,
"height" : 400 ,
"size" : 20903 ,
"mime_type" : "image\/png"
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/info?id=31ddacd40e5b645adecb7ec308225113&format=xml
Query parameters
id = 31ddacd40e5b645adecb7ec308225113
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<id> 31ddacd40e5b645adecb7ec308225113 </id>
<name> this is my resource </name>
<creation> 2019-06-25 13:01:23 </creation>
<url> https://cdn.endpoint/path/to/resource </url>
<width> 533 </width>
<height> 400 </height>
<size> 20903 </size>
<mime_type> image/png </mime_type>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/info?id=31ddacd40e5b645adecb7ec308225113&format=txt
Query parameters
id = 31ddacd40e5b645adecb7ec308225113
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_id = 31ddacd40e5b645adecb7ec308225113
result_data_name = this is my resource
result_data_creation = 2019-06-25 13:01:23
result_data_url = https://cdn.endpoint/path/to/resource
result_data_width = 533
result_data_height = 400
result_data_size = 20903
result_data_mime_type = image/png
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/info?id=31ddacd40e5b645adecb7ec308225113&format=plain
Query parameters
id = 31ddacd40e5b645adecb7ec308225113
format = plain
Response
31ddacd40e5b645adecb7ec308225113
this is my resource
2019-06-25 13:01:23
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
parameter
description
idID
ID of the CDN resource
Return values
parameter
description
data
array containing required information on CDN resources
Available fields in the data array:
id : ID of the CDN resource name : name of the CDN resource creation : date/time when the CDN resource was created url : URL of the CDN resource width : width in pixels of the CDN resource, if available height : height in pixels of the CDN resource, if available size : size in bytes of the CDN resource, if available mime_type : MIME type of the resource, or 'external_url' for external URLs Available fields in filters :
max_size : maximum size (in bytes) of the image max_width : maximum width (in pixels) of the image max_height : maximum height (in pixels) of the image external : 1 to extract only external media, 0 to extract only internal media
/cdns/links /cdns/links/add
access: [WRITE]
This method allows to add an association between a CDN resource and a key and/or a tracking link. This method allows multiple instances for the combination (CDN resource,key).
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=0be03f3a17b48558138099f95b668b7b&value=%7B%22position%22%3A%22top_left%22%7D
Query parameters
key = my_custom_config_key
cdn_id = 0be03f3a17b48558138099f95b668b7b
value = {"position":"top_left"}
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"added" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=0be03f3a17b48558138099f95b668b7b&value=%7B%22position%22%3A%22top_left%22%7D&format=xml
Query parameters
key = my_custom_config_key
cdn_id = 0be03f3a17b48558138099f95b668b7b
value = {"position":"top_left"}
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<added> 1 </added>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=0be03f3a17b48558138099f95b668b7b&value=%7B%22position%22%3A%22top_left%22%7D&format=txt
Query parameters
key = my_custom_config_key
cdn_id = 0be03f3a17b48558138099f95b668b7b
value = {"position":"top_left"}
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_added = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=0be03f3a17b48558138099f95b668b7b&value=%7B%22position%22%3A%22top_left%22%7D&format=plain
Query parameters
key = my_custom_config_key
cdn_id = 0be03f3a17b48558138099f95b668b7b
value = {"position":"top_left"}
format = plain
Response
1
Required parameters
parameter
description
max length
cdn_idID
ID of the CDN resource
keySTRING
key that identifies the CDN resource/tracking link association, available values: reports_config
, instaurl
, instaurl_bg
, instaurl_images
, preview_image
50
Optional parameters
parameter
description
url_idID
ID of the tracking link
valueJSON
value for the association, it must be a stringified JSON
A maximum of 100 CDN resource/tracking link associations is allowed per tracking link. Parameter url_id
is mandatory when key
is equal to one of these keys: instaurl
, instaurl_bg
, instaurl_images
, preview_image
Return values
parameter
description
added
1 on success, 0 otherwise
/cdns/links/delete
access: [WRITE]
This method deletes all the associations between a CDN resource and a key and/or a tracking link. If the resource ID is not passed, it deletes all associations by using the key.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=534cc892ae10b5930dc66172abb14d9e
Query parameters
key = my_custom_config_key
cdn_id = 534cc892ae10b5930dc66172abb14d9e
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"deleted" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=534cc892ae10b5930dc66172abb14d9e&format=xml
Query parameters
key = my_custom_config_key
cdn_id = 534cc892ae10b5930dc66172abb14d9e
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<deleted> 1 </deleted>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=534cc892ae10b5930dc66172abb14d9e&format=txt
Query parameters
key = my_custom_config_key
cdn_id = 534cc892ae10b5930dc66172abb14d9e
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_deleted = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=534cc892ae10b5930dc66172abb14d9e&format=plain
Query parameters
key = my_custom_config_key
cdn_id = 534cc892ae10b5930dc66172abb14d9e
format = plain
Response
1
Required parameters
parameter
description
max length
keySTRING
key that identifies the CDN resource/tracking link association, available values: reports_config
, instaurl
, instaurl_bg
, instaurl_images
, preview_image
50
Optional parameters
parameter
description
cdn_idID
if passed, only the associations with the CDN resource identified by this ID will be deleted
url_idID
if passed, only the associations with the tracking link identified by this ID will be deleted
Parameter url_id
is mandatory when key
is equal to one of these keys: instaurl
, instaurl_bg
, instaurl_images
, preview_image
Return values
parameter
description
deleted
number of deleted associations
/cdns/links/get
access: [READ]
This method returns all the associations between a CDN resource and a key and/or a tracking link.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=6153de78431af7aa46bfdf0bf1b0bc92
Query parameters
key = my_custom_config_key
cdn_id = 6153de78431af7aa46bfdf0bf1b0bc92
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : {
"id" : "4d17c56552a98348f22796d6e5264fa1" ,
"key" : "my_custom_config_key" ,
"value" : {
"position" : "top_left"
} ,
"cdn_id" : "6153de78431af7aa46bfdf0bf1b0bc92" ,
"url_id" : "53b21071f7485089c0793147c6c66dd8" ,
"name" : "this is my resource" ,
"creation" : "2019-06-25 13:01:23" ,
"url" : "https:\/\/cdn.endpoint\/path\/to\/resource" ,
"width" : 533 ,
"height" : 400 ,
"size" : 20903 ,
"mime_type" : "image\/png"
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=6153de78431af7aa46bfdf0bf1b0bc92&format=xml
Query parameters
key = my_custom_config_key
cdn_id = 6153de78431af7aa46bfdf0bf1b0bc92
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<id> 4d17c56552a98348f22796d6e5264fa1 </id>
<key> my_custom_config_key </key>
<value>
<position> top_left </position>
</value>
<cdn_id> 6153de78431af7aa46bfdf0bf1b0bc92 </cdn_id>
<url_id> 53b21071f7485089c0793147c6c66dd8 </url_id>
<name> this is my resource </name>
<creation> 2019-06-25 13:01:23 </creation>
<url> https://cdn.endpoint/path/to/resource </url>
<width> 533 </width>
<height> 400 </height>
<size> 20903 </size>
<mime_type> image/png </mime_type>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=6153de78431af7aa46bfdf0bf1b0bc92&format=txt
Query parameters
key = my_custom_config_key
cdn_id = 6153de78431af7aa46bfdf0bf1b0bc92
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_id = 4d17c56552a98348f22796d6e5264fa1
result_data_key = my_custom_config_key
result_data_value_position = top_left
result_data_cdn_id = 6153de78431af7aa46bfdf0bf1b0bc92
result_data_url_id = 53b21071f7485089c0793147c6c66dd8
result_data_name = this is my resource
result_data_creation = 2019-06-25 13:01:23
result_data_url = https://cdn.endpoint/path/to/resource
result_data_width = 533
result_data_height = 400
result_data_size = 20903
result_data_mime_type = image/png
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=6153de78431af7aa46bfdf0bf1b0bc92&format=plain
Query parameters
key = my_custom_config_key
cdn_id = 6153de78431af7aa46bfdf0bf1b0bc92
format = plain
Response
4d17c56552a98348f22796d6e5264fa1
my_custom_config_key
top_left
6153de78431af7aa46bfdf0bf1b0bc92
53b21071f7485089c0793147c6c66dd8
this is my resource
2019-06-25 13:01:23
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
parameter
description
max length
keySTRING
key that identifies the CDN resource/tracking link association, available values: reports_config
, instaurl
, instaurl_bg
, instaurl_images
, preview_image
50
Optional parameters
parameter
description
cdn_idID
if passed, only the associations with the CDN resource identified by this ID will be returned
url_idID
if passed, only the associations with the tracking link identified by this ID will be returned
A maximum of 100 associations is always returned. Parameter url_id
is mandatory when key
is equal to one of these keys: instaurl
, instaurl_bg
, instaurl_images
, preview_image
Return values
parameter
description
data
array containing information on the association and the linked CDN resource
/cdns/links/set
access: [WRITE]
This method allows to set the association between a CDN resource and a key and/or a tracking link. This method allows only one instance for the combination (CDN resource,key).
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=65d714f1f8b93687fe9b917dcb0d7a5a&value=%7B%22position%22%3A%22top_left%22%7D
Query parameters
key = my_custom_config_key
cdn_id = 65d714f1f8b93687fe9b917dcb0d7a5a
value = {"position":"top_left"}
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"set" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=65d714f1f8b93687fe9b917dcb0d7a5a&value=%7B%22position%22%3A%22top_left%22%7D&format=xml
Query parameters
key = my_custom_config_key
cdn_id = 65d714f1f8b93687fe9b917dcb0d7a5a
value = {"position":"top_left"}
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<set> 1 </set>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=65d714f1f8b93687fe9b917dcb0d7a5a&value=%7B%22position%22%3A%22top_left%22%7D&format=txt
Query parameters
key = my_custom_config_key
cdn_id = 65d714f1f8b93687fe9b917dcb0d7a5a
value = {"position":"top_left"}
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_set = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=65d714f1f8b93687fe9b917dcb0d7a5a&value=%7B%22position%22%3A%22top_left%22%7D&format=plain
Query parameters
key = my_custom_config_key
cdn_id = 65d714f1f8b93687fe9b917dcb0d7a5a
value = {"position":"top_left"}
format = plain
Response
1
Required parameters
parameter
description
max length
cdn_idID
ID of the CDN resource
keySTRING
key that identifies the CDN resource/tracking link association, available values: reports_config
, instaurl
, instaurl_bg
, instaurl_images
, preview_image
50
Optional parameters
parameter
description
url_idID
ID of the tracking link
valueJSON
value for the association, it must be a stringified JSON
Parameter url_id
is mandatory when key
is equal to one of these keys: instaurl
, instaurl_bg
, instaurl_images
, preview_image
Return values
parameter
description
set
1 on success, 0 otherwise
/cdns/list
access: [READ]
This method returns a list of resource on the CDN linked with the current user.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/list?type=image
Query parameters
type = image
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 1 ,
"data" : {
"id" : "1234567890abcdef" ,
"name" : "this is my resource" ,
"creation" : "2019-06-25 13:01:23" ,
"url" : "https:\/\/cdn.endpoint\/path\/to\/resource" ,
"width" : 533 ,
"height" : 400 ,
"size" : 20903 ,
"mime_type" : "image\/png"
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/list?type=image&format=xml
Query parameters
type = image
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 1 </count>
<data>
<id> 1234567890abcdef </id>
<name> this is my resource </name>
<creation> 2019-06-25 13:01:23 </creation>
<url> https://cdn.endpoint/path/to/resource </url>
<width> 533 </width>
<height> 400 </height>
<size> 20903 </size>
<mime_type> image/png </mime_type>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/list?type=image&format=txt
Query parameters
type = image
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 1
result_data_id = 1234567890abcdef
result_data_name = this is my resource
result_data_creation = 2019-06-25 13:01:23
result_data_url = https://cdn.endpoint/path/to/resource
result_data_width = 533
result_data_height = 400
result_data_size = 20903
result_data_mime_type = image/png
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/list?type=image&format=plain
Query parameters
type = image
format = plain
Response
1
1234567890abcdef
this is my resource
2019-06-25 13:01:23
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
Optional parameters
parameter
description
filtersJSON
filters to be used extracing media
lengthINTEGER
extracts this number of CDN resources (maxmimum allowed: 100)
searchSTRING
filters CDN resources to be extracted by searching them
startINTEGER
starts to extract CDN resources from this position
Return values
parameter
description
count
total number of (filtered) CDN resources
data
array containing required information on CDN resources
Available fields in the data array:
id : ID of the CDN resource name : name of the CDN resource creation : date/time when the CDN resource was created url : URL of the CDN resource width : width in pixels of the CDN resource, if available height : height in pixels of the CDN resource, if available size : size in bytes of the CDN resource, if available mime_type : MIME type of the resource, or 'external_url' for external URLs Available fields in filters :
max_size : maximum size (in bytes) of the image max_width : maximum width (in pixels) of the image max_height : maximum height (in pixels) of the image external : 1 to extract only external media, 0 to extract only internal media
/cdns/property
access: [READ]
This method return limits for uploading a resource on the CDN.
Example 1 (json)
Request
https://joturl.com/a/i1/cdns/property
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"image" : {
"max_size" : 5242880 ,
"allowed_types" : [
"gif" ,
"jpg" ,
"png" ,
"svg" ,
"webp"
] ,
"allowed_mimes" : [
"image\/gif" ,
"image\/jpeg" ,
"image\/jpg" ,
"image\/pjpeg" ,
"image\/x-png" ,
"image\/png" ,
"image\/svg+xml" ,
"application\/svg+xml" ,
"image\/webp"
]
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/cdns/property?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<image>
<max_size> 5242880 </max_size>
<allowed_types>
<i0> gif </i0>
<i1> jpg </i1>
<i2> png </i2>
<i3> svg </i3>
<i4> webp </i4>
</allowed_types>
<allowed_mimes>
<i0> image/gif </i0>
<i1> image/jpeg </i1>
<i2> image/jpg </i2>
<i3> image/pjpeg </i3>
<i4> image/x-png </i4>
<i5> image/png </i5>
<i6> image/svg+xml </i6>
<i7> application/svg+xml </i7>
<i8> image/webp </i8>
</allowed_mimes>
</image>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/cdns/property?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_image_max_size = 5242880
result_image_allowed_types_0 = gif
result_image_allowed_types_1 = jpg
result_image_allowed_types_2 = png
result_image_allowed_types_3 = svg
result_image_allowed_types_4 = webp
result_image_allowed_mimes_0 = image/gif
result_image_allowed_mimes_1 = image/jpeg
result_image_allowed_mimes_2 = image/jpg
result_image_allowed_mimes_3 = image/pjpeg
result_image_allowed_mimes_4 = image/x-png
result_image_allowed_mimes_5 = image/png
result_image_allowed_mimes_6 = image/svg+xml
result_image_allowed_mimes_7 = application/svg+xml
result_image_allowed_mimes_8 = image/webp
Example 4 (plain)
Request
https://joturl.com/a/i1/cdns/property?format=plain
Query parameters
format = plain
Response
5242880
gif
jpg
png
svg
webp
image/gif
image/jpeg
image/jpg
image/pjpeg
image/x-png
image/png
image/svg+xml
application/svg+xml
image/webp
Example 5 (json)
Request
https://joturl.com/a/i1/cdns/property?type=image
Query parameters
type = image
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"max_size" : 5242880 ,
"allowed_types" : [
"gif" ,
"jpg" ,
"png" ,
"svg" ,
"webp"
] ,
"allowed_mimes" : [
"image\/gif" ,
"image\/jpeg" ,
"image\/jpg" ,
"image\/pjpeg" ,
"image\/x-png" ,
"image\/png" ,
"image\/svg+xml" ,
"application\/svg+xml" ,
"image\/webp"
]
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/cdns/property?type=image&format=xml
Query parameters
type = image
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<max_size> 5242880 </max_size>
<allowed_types>
<i0> gif </i0>
<i1> jpg </i1>
<i2> png </i2>
<i3> svg </i3>
<i4> webp </i4>
</allowed_types>
<allowed_mimes>
<i0> image/gif </i0>
<i1> image/jpeg </i1>
<i2> image/jpg </i2>
<i3> image/pjpeg </i3>
<i4> image/x-png </i4>
<i5> image/png </i5>
<i6> image/svg+xml </i6>
<i7> application/svg+xml </i7>
<i8> image/webp </i8>
</allowed_mimes>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/cdns/property?type=image&format=txt
Query parameters
type = image
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_max_size = 5242880
result_allowed_types_0 = gif
result_allowed_types_1 = jpg
result_allowed_types_2 = png
result_allowed_types_3 = svg
result_allowed_types_4 = webp
result_allowed_mimes_0 = image/gif
result_allowed_mimes_1 = image/jpeg
result_allowed_mimes_2 = image/jpg
result_allowed_mimes_3 = image/pjpeg
result_allowed_mimes_4 = image/x-png
result_allowed_mimes_5 = image/png
result_allowed_mimes_6 = image/svg+xml
result_allowed_mimes_7 = application/svg+xml
result_allowed_mimes_8 = image/webp
Example 8 (plain)
Request
https://joturl.com/a/i1/cdns/property?type=image&format=plain
Query parameters
type = image
format = plain
Response
5242880
gif
jpg
png
svg
webp
image/gif
image/jpeg
image/jpg
image/pjpeg
image/x-png
image/png
image/svg+xml
application/svg+xml
image/webp
Optional parameters
parameter
description
typeSTRING
CDN resource type, available types: image
Return values
parameter
description
[ARRAY]
it is an object (type,(max_size,allowed_types,allowed_mimes)), see parameters max_size, allowed_types, allowed_mimes for details
allowed_mimes
array containing the allowed mimes for the resource
allowed_types
array containing the allowed types for the resource
max_size
it is the maximum size in bytes the resource can have
If type is not passed, only [ARRAY] is returned which in turn contains max_size , allowed_types , allowed_mimes . If type is passed, only max_size , allowed_types , allowed_mimes are returned for the specified type.
/conversions /conversions/affiliates /conversions/affiliates/count
access: [READ]
This method returns the number of affiliates.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/affiliates/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 16
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/affiliates/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 16 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/affiliates/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 16
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/affiliates/count?format=plain
Query parameters
format = plain
Response
16
Optional parameters
parameter
description
idID
ID of the affiliate network
Return values
parameter
description
count
number of affiliate networks
/conversions/affiliates/list
access: [READ]
This method lists all affiliates network.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/affiliates/list
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : {
"id" : "644a4b356f74446f62613864764b3762725a343966673d3d" ,
"name" : "Network name" ,
"actual_url_params" : "id={:CLICK_ID:}" ,
"postback_url_params" : "clickid={id}&comm={comm}" ,
"integration_link" : ""
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/affiliates/list?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<id> 644a4b356f74446f62613864764b3762725a343966673d3d </id>
<name> Network name </name>
<actual_url_params> id={:CLICK_ID:} </actual_url_params>
<postback_url_params> clickid={id}&comm={comm} </postback_url_params>
<integration_link> </integration_link>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/affiliates/list?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_id = 644a4b356f74446f62613864764b3762725a343966673d3d
result_data_name = Network name
result_data_actual_url_params = id={:CLICK_ID:}
result_data_postback_url_params = clickid={id}&comm={comm}
result_data_integration_link =
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/affiliates/list?format=plain
Query parameters
format = plain
Response
644a4b356f74446f62613864764b3762725a343966673d3d
Network name
id={:CLICK_ID:}
clickid={id}&comm={comm}
Optional parameters
parameter
description
idID
ID of the affiliate network
lengthINTEGER
number of items to return (default: 1000, max value: 1000)
searchSTRING
filter items by searching them
startINTEGER
index of the starting item to retrieve (default: 0)
Return values
parameter
description
count
number of affiliate networks
data
array containing affiliate networks
/conversions/codes /conversions/codes/add
access: [WRITE]
Create a conversion code for the logged user.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code
Query parameters
name = name of the new conversion code
notes = this is a note for the conversion code
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"name" : "name of the new conversion code" ,
"notes" : "this is a note for the conversion code" ,
"id" : "f6dedb4ed20b61fae639b1df09675538" ,
"enable_postback_url" : 0 ,
"affiliate_network_id" : ""
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code&format=xml
Query parameters
name = name of the new conversion code
notes = this is a note for the conversion code
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<name> name of the new conversion code </name>
<notes> this is a note for the conversion code </notes>
<id> f6dedb4ed20b61fae639b1df09675538 </id>
<enable_postback_url> 0 </enable_postback_url>
<affiliate_network_id> </affiliate_network_id>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code&format=txt
Query parameters
name = name of the new conversion code
notes = this is a note for the conversion code
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_name = name of the new conversion code
result_notes = this is a note for the conversion code
result_id = f6dedb4ed20b61fae639b1df09675538
result_enable_postback_url = 0
result_affiliate_network_id =
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code&format=plain
Query parameters
name = name of the new conversion code
notes = this is a note for the conversion code
format = plain
Response
name of the new conversion code
this is a note for the conversion code
f6dedb4ed20b61fae639b1df09675538
0
Required parameters
parameter
description
max length
nameSTRING
conversion name
100
Optional parameters
parameter
description
max length
affiliate_network_idID
ID of the linked affiliate network, see i1/conversions/affliates/list for details
enable_postback_urlBOOLEAN
1 to enable postback URLs for the conversion
notesSTRING
notes for the conversion
255
Return values
parameter
description
affiliate_network_id
echo back of the affiliate_network_id input parameter
enable_postback_url
echo back of the enable_postback_url input parameter
id
ID of the conversion code
name
echo back of the name input parameter
notes
echo back of the notes input parameter
/conversions/codes/count
access: [READ]
This method returns the number of defined conversion codes.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 4321
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 4321 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 4321
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/count?format=plain
Query parameters
format = plain
Response
4321
Example 5 (json)
Request
https://joturl.com/a/i1/conversions/codes/count?search=text+to+search
Query parameters
search = text to search
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 1234
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/conversions/codes/count?search=text+to+search&format=xml
Query parameters
search = text to search
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 1234 </count>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/conversions/codes/count?search=text+to+search&format=txt
Query parameters
search = text to search
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 1234
Example 8 (plain)
Request
https://joturl.com/a/i1/conversions/codes/count?search=text+to+search&format=plain
Query parameters
search = text to search
format = plain
Response
1234
Optional parameters
parameter
description
searchSTRING
filters conversion codes to be extracted by searching them
Return values
parameter
description
count
number of (filtered) conversion codes
/conversions/codes/delete
access: [WRITE]
This method deletes a set of conversion codes using their IDs.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c
Query parameters
ids = 23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"deleted" : 3
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c&format=xml
Query parameters
ids = 23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<deleted> 3 </deleted>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c&format=txt
Query parameters
ids = 23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_deleted = 3
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c&format=plain
Query parameters
ids = 23e9e17d4a70211afd2a85eff1e2e383,4cb4f7a7f112eddd6df612efd5028ea0,76a9df1c9315c8597b66cf28f25ba97c
format = plain
Response
3
Example 5 (json)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5
Query parameters
ids = 66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"ids" : [
"66f64d0ec5fa88e77f43221012d7aafd"
] ,
"deleted" : 2
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5&format=xml
Query parameters
ids = 66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<ids>
<i0> 66f64d0ec5fa88e77f43221012d7aafd </i0>
</ids>
<deleted> 2 </deleted>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5&format=txt
Query parameters
ids = 66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_ids_0 = 66f64d0ec5fa88e77f43221012d7aafd
result_deleted = 2
Example 8 (plain)
Request
https://joturl.com/a/i1/conversions/codes/delete?ids=66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5&format=plain
Query parameters
ids = 66f64d0ec5fa88e77f43221012d7aafd,51a61e2547f0f07c6329f17a10b5792d,63060ef53da34fd17d2fbbfdc239b2f5
format = plain
Response
66f64d0ec5fa88e77f43221012d7aafd
2
Required parameters
parameter
description
idsARRAY_OF_IDS
comma-separated list of conversion code IDs to be deleted
Return values
parameter
description
deleted
number of deleted conversion codes
ids
[OPTIONAL] list of conversion code IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred
/conversions/codes/edit
access: [WRITE]
Edit fields of a conversion.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/edit?id=c244e10e9c8b33f458b7635e48b2a9fb¬es=new+notes+for+the+conversion+code
Query parameters
id = c244e10e9c8b33f458b7635e48b2a9fb
notes = new notes for the conversion code
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "c244e10e9c8b33f458b7635e48b2a9fb" ,
"notes" : "new notes for the conversion code"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/edit?id=c244e10e9c8b33f458b7635e48b2a9fb¬es=new+notes+for+the+conversion+code&format=xml
Query parameters
id = c244e10e9c8b33f458b7635e48b2a9fb
notes = new notes for the conversion code
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> c244e10e9c8b33f458b7635e48b2a9fb </id>
<notes> new notes for the conversion code </notes>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/edit?id=c244e10e9c8b33f458b7635e48b2a9fb¬es=new+notes+for+the+conversion+code&format=txt
Query parameters
id = c244e10e9c8b33f458b7635e48b2a9fb
notes = new notes for the conversion code
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = c244e10e9c8b33f458b7635e48b2a9fb
result_notes = new notes for the conversion code
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/edit?id=c244e10e9c8b33f458b7635e48b2a9fb¬es=new+notes+for+the+conversion+code&format=plain
Query parameters
id = c244e10e9c8b33f458b7635e48b2a9fb
notes = new notes for the conversion code
format = plain
Response
c244e10e9c8b33f458b7635e48b2a9fb
new notes for the conversion code
Required parameters
parameter
description
idID
ID of the conversion code
Optional parameters
parameter
description
max length
affiliate_network_idID
ID of the affiliate network linked to the conversion code, it is ignored if enable_postback_url = 0
enable_postback_urlBOOLEAN
1 to enabled postback URLs for the conversion code, 0 to disable it
nameSTRING
name of the conversion code
100
notesSTRING
notes for the conversion code
255
Return values
parameter
description
affiliate_network_id
[OPTIONAL] echo back of the affiliate_network_id input parameter
enable_postback_url
[OPTIONAL] echo back of the enable_postback_url input parameter
id
echo back of the id input parameter
name
[OPTIONAL] echo back of the name input parameter
notes
[OPTIONAL] echo back of the notes input parameter
/conversions/codes/info
access: [READ]
This method returns information about conversion code.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/info?id=457a9e97a650ccb6e4a423702176a668&fields=id,name,notes
Query parameters
id = 457a9e97a650ccb6e4a423702176a668
fields = id,name,notes
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "457a9e97a650ccb6e4a423702176a668" ,
"name" : "name" ,
"notes" : "notes"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/info?id=457a9e97a650ccb6e4a423702176a668&fields=id,name,notes&format=xml
Query parameters
id = 457a9e97a650ccb6e4a423702176a668
fields = id,name,notes
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 457a9e97a650ccb6e4a423702176a668 </id>
<name> name </name>
<notes> notes </notes>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/info?id=457a9e97a650ccb6e4a423702176a668&fields=id,name,notes&format=txt
Query parameters
id = 457a9e97a650ccb6e4a423702176a668
fields = id,name,notes
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 457a9e97a650ccb6e4a423702176a668
result_name = name
result_notes = notes
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/info?id=457a9e97a650ccb6e4a423702176a668&fields=id,name,notes&format=plain
Query parameters
id = 457a9e97a650ccb6e4a423702176a668
fields = id,name,notes
format = plain
Response
457a9e97a650ccb6e4a423702176a668
name
notes
Required parameters
parameter
description
fieldsARRAY
comma separated list of fields to return, available fields: id, ext_id, ext_postback_id, name, notes, enable_postback_url, affiliate_network_id, creation, clicks, last_click, value, performance
idID
NA
Return values
/conversions/codes/list
access: [READ]
This method returns a list of user's conversions, specified in a comma separated input called fields.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name
Query parameters
fields = count,id,name
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 5 ,
"data" : [
{
"id" : "7ae043bc93dcafe994fcc10a5c4fb9eb" ,
"name" : "conversion code 1"
} ,
{
"id" : "456bae3ff32efffd739133297d79f2dd" ,
"name" : "conversion code 2"
} ,
{
"id" : "e9b4977027f85a9f4df0697237fec4ec" ,
"name" : "conversion code 3"
} ,
{
"id" : "b906c9b81feab3e08dfe35e26139f5e9" ,
"name" : "conversion code 4"
} ,
{
"id" : "7d81a0d9f5b7d686aae0c5faca891442" ,
"name" : "conversion code 5"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name&format=xml
Query parameters
fields = count,id,name
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 5 </count>
<data>
<i0>
<id> 7ae043bc93dcafe994fcc10a5c4fb9eb </id>
<name> conversion code 1 </name>
</i0>
<i1>
<id> 456bae3ff32efffd739133297d79f2dd </id>
<name> conversion code 2 </name>
</i1>
<i2>
<id> e9b4977027f85a9f4df0697237fec4ec </id>
<name> conversion code 3 </name>
</i2>
<i3>
<id> b906c9b81feab3e08dfe35e26139f5e9 </id>
<name> conversion code 4 </name>
</i3>
<i4>
<id> 7d81a0d9f5b7d686aae0c5faca891442 </id>
<name> conversion code 5 </name>
</i4>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name&format=txt
Query parameters
fields = count,id,name
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 5
result_data_0_id = 7ae043bc93dcafe994fcc10a5c4fb9eb
result_data_0_name = conversion code 1
result_data_1_id = 456bae3ff32efffd739133297d79f2dd
result_data_1_name = conversion code 2
result_data_2_id = e9b4977027f85a9f4df0697237fec4ec
result_data_2_name = conversion code 3
result_data_3_id = b906c9b81feab3e08dfe35e26139f5e9
result_data_3_name = conversion code 4
result_data_4_id = 7d81a0d9f5b7d686aae0c5faca891442
result_data_4_name = conversion code 5
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name&format=plain
Query parameters
fields = count,id,name
format = plain
Response
5
7ae043bc93dcafe994fcc10a5c4fb9eb
conversion code 1
456bae3ff32efffd739133297d79f2dd
conversion code 2
e9b4977027f85a9f4df0697237fec4ec
conversion code 3
b906c9b81feab3e08dfe35e26139f5e9
conversion code 4
7d81a0d9f5b7d686aae0c5faca891442
conversion code 5
Required parameters
parameter
description
fieldsARRAY
comma separated list of fields to return, available fields: count, id, ext_id, ext_postback_id, name, notes, enable_postback_url, affiliate_network_id, creation, clicks, last_click, value, performance
Optional parameters
parameter
description
lengthINTEGER
extracts this number of coversion codes (maxmimum allowed: 100)
orderbyARRAY
orders coversion codes by field, available fields: count, id, ext_id, ext_postback_id, name, notes, enable_postback_url, affiliate_network_id, creation, clicks, last_click, value, performance
searchSTRING
filters coversion codes to be extracted by searching them
sortSTRING
sorts coversion codes in ascending (ASC) or descending (DESC) order
startINTEGER
starts to extract coversion codes from this position
Return values
parameter
description
count
[OPTIONAL] total number of (filtered) coversion codes, returned only if count is passed in fields
data
array containing required information on coversion codes
Available fields in the data array:
id : ID of the conversion code ext_id : identifier of the conversion code that can be used outside the dashboard, id is only valid within the dashboard ext_postback_id : identifier of the associated postback URL, it can be used outside the dashboard name : name of the conversion code notes : notes for the conversion code enable_postback_url : 1 if postback URLs are enabled for the conversion code, 0 otherwise affiliate_network_id : ID of the affiliate network, to be ignored if enable_postback_url = 0
creation : creation date time clicks : number of occurred conversions last_click : date/time of the last click value : total value for the occurred conversions performance : performance meter of this conversion code, 0 if the conversion pixel has 0 clicks or if is was created by less than 3 hours, otherwise it is the average number of clicks per hour Parameters ext_id and ext_postback_id are always returned regardless they are passed in fields
.
/conversions/codes/params /conversions/codes/params/count
access: [READ]
This method returns the number of parameters linked to a conversion code.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/params/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/params/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 1 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/params/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/params/count?format=plain
Query parameters
format = plain
Response
1
Required parameters
parameter
description
idID
ID of the conversion code
Optional parameters
Return values
parameter
description
count
number of (filtered) conversion parameters
/conversions/codes/params/has_params
access: [READ]
This method returns the number of parameters related to a conversion code.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/params/has_params?id=a8ba504f7c76d9d1208c711637457d34
Query parameters
id = a8ba504f7c76d9d1208c711637457d34
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"has_params" : 1 ,
"param" : 1 ,
"ep00" : 1 ,
"ep01" : 0 ,
"ep02" : 0 ,
"ep03" : 0 ,
"ep04" : 0 ,
"ep05" : 0 ,
"ep06" : 0 ,
"ep07" : 0 ,
"ep08" : 0 ,
"ep09" : 0 ,
"ep10" : 0 ,
"ep11" : 0 ,
"ep12" : 0 ,
"ep13" : 0 ,
"ep14" : 0
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/params/has_params?id=a8ba504f7c76d9d1208c711637457d34&format=xml
Query parameters
id = a8ba504f7c76d9d1208c711637457d34
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<has_params> 1 </has_params>
<param> 1 </param>
<ep00> 1 </ep00>
<ep01> 0 </ep01>
<ep02> 0 </ep02>
<ep03> 0 </ep03>
<ep04> 0 </ep04>
<ep05> 0 </ep05>
<ep06> 0 </ep06>
<ep07> 0 </ep07>
<ep08> 0 </ep08>
<ep09> 0 </ep09>
<ep10> 0 </ep10>
<ep11> 0 </ep11>
<ep12> 0 </ep12>
<ep13> 0 </ep13>
<ep14> 0 </ep14>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/params/has_params?id=a8ba504f7c76d9d1208c711637457d34&format=txt
Query parameters
id = a8ba504f7c76d9d1208c711637457d34
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_has_params = 1
result_param = 1
result_ep00 = 1
result_ep01 = 0
result_ep02 = 0
result_ep03 = 0
result_ep04 = 0
result_ep05 = 0
result_ep06 = 0
result_ep07 = 0
result_ep08 = 0
result_ep09 = 0
result_ep10 = 0
result_ep11 = 0
result_ep12 = 0
result_ep13 = 0
result_ep14 = 0
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/params/has_params?id=a8ba504f7c76d9d1208c711637457d34&format=plain
Query parameters
id = a8ba504f7c76d9d1208c711637457d34
format = plain
Response
1
1
1
0
0
0
0
0
0
0
0
0
0
0
0
0
0
Required parameters
parameter
description
idID
ID of the conversion code
Return values
parameter
description
ep00
1 if the extended parameter ep00 is associated to the conversion code
ep01
1 if the extended parameter ep01 is associated to the conversion code
ep02
1 if the extended parameter ep02 is associated to the conversion code
ep03
1 if the extended parameter ep03 is associated to the conversion code
ep04
1 if the extended parameter ep04 is associated to the conversion code
ep05
1 if the extended parameter ep05 is associated to the conversion code
ep06
1 if the extended parameter ep06 is associated to the conversion code
ep07
1 if the extended parameter ep07 is associated to the conversion code
ep08
1 if the extended parameter ep08 is associated to the conversion code
ep09
1 if the extended parameter ep09 is associated to the conversion code
ep10
1 if the extended parameter ep10 is associated to the conversion code
ep11
1 if the extended parameter ep11 is associated to the conversion code
ep12
1 if the extended parameter ep12 is associated to the conversion code
ep13
1 if the extended parameter ep13 is associated to the conversion code
ep14
1 if the extended parameter ep14 is associated to the conversion code
has_params
1 if at least one extended parameter is associated to the conversion code
param
1 if param is associated to the conversion code
/conversions/codes/params/list
access: [READ]
This method returns a list of parameters related to a conversion code.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=d75fe45566b45e2bcf15ca869326aea6
Query parameters
id = d75fe45566b45e2bcf15ca869326aea6
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 2 ,
"data" : [
{
"param_id" : "75402268e178e8a8594d60dc9a4392c7" ,
"param" : "this is the value #1 of parameter 'param'"
} ,
{
"param_id" : "bf254e85b60aa26407d93223c55554c5" ,
"param" : "this is the value #2 of parameter 'param'"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=d75fe45566b45e2bcf15ca869326aea6&format=xml
Query parameters
id = d75fe45566b45e2bcf15ca869326aea6
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 2 </count>
<data>
<i0>
<param_id> 75402268e178e8a8594d60dc9a4392c7 </param_id>
<param> this is the value #1 of parameter 'param' </param>
</i0>
<i1>
<param_id> bf254e85b60aa26407d93223c55554c5 </param_id>
<param> this is the value #2 of parameter 'param' </param>
</i1>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=d75fe45566b45e2bcf15ca869326aea6&format=txt
Query parameters
id = d75fe45566b45e2bcf15ca869326aea6
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 2
result_data_0_param_id = 75402268e178e8a8594d60dc9a4392c7
result_data_0_param = this is the value #1 of parameter 'param'
result_data_1_param_id = bf254e85b60aa26407d93223c55554c5
result_data_1_param = this is the value #2 of parameter 'param'
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=d75fe45566b45e2bcf15ca869326aea6&format=plain
Query parameters
id = d75fe45566b45e2bcf15ca869326aea6
format = plain
Response
2
75402268e178e8a8594d60dc9a4392c7
this is the value #1 of parameter 'param'
bf254e85b60aa26407d93223c55554c5
this is the value #2 of parameter 'param'
Example 5 (json)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=c23fc2e422a7728ee357f1ce7e682de3¶m_num=0
Query parameters
id = c23fc2e422a7728ee357f1ce7e682de3
param_num = 0
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 1 ,
"data" : [
{
"param_id" : "130885b8678e75b6b1737f413cc0767f" ,
"param" : "this is the value of extended parameter 'ep00'"
}
]
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=c23fc2e422a7728ee357f1ce7e682de3¶m_num=0&format=xml
Query parameters
id = c23fc2e422a7728ee357f1ce7e682de3
param_num = 0
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 1 </count>
<data>
<i0>
<param_id> 130885b8678e75b6b1737f413cc0767f </param_id>
<param> this is the value of extended parameter 'ep00' </param>
</i0>
</data>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=c23fc2e422a7728ee357f1ce7e682de3¶m_num=0&format=txt
Query parameters
id = c23fc2e422a7728ee357f1ce7e682de3
param_num = 0
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 1
result_data_0_param_id = 130885b8678e75b6b1737f413cc0767f
result_data_0_param = this is the value of extended parameter 'ep00'
Example 8 (plain)
Request
https://joturl.com/a/i1/conversions/codes/params/list?id=c23fc2e422a7728ee357f1ce7e682de3¶m_num=0&format=plain
Query parameters
id = c23fc2e422a7728ee357f1ce7e682de3
param_num = 0
format = plain
Response
1
130885b8678e75b6b1737f413cc0767f
this is the value of extended parameter 'ep00'
Required parameters
parameter
description
idID
ID of the conversion code
Optional parameters
parameter
description
lengthINTEGER
extracts this number of coversion parameters (maxmimum allowed: 100)
param_numSTRING
if not passed or param_num = 255
it returns the parameter param
, if param_num = 0
it returns the extended paarameter ep00
, ..., if param_num = 7
it returns the extended paarameter ep07
, ..., if param_num = 14
it returns the extended paarameter ep14
,
searchSTRING
filters coversion parameters to be extracted by searching them
startINTEGER
starts to extract coversion parameters from this position
Return values
parameter
description
count
number of available parameter with the specified param_num
data
array containing required information on coversion code parameters
/conversions/codes/urls /conversions/codes/urls/count
access: [READ]
This method returns the number of tracking links liked to a conversion code.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/urls/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 5
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/urls/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 5 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/urls/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 5
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/urls/count?format=plain
Query parameters
format = plain
Response
5
Required parameters
parameter
description
idID
ID of the conversion code
Optional parameters
parameter
description
searchSTRING
filters tracking pixels to be extracted by searching them
Return values
parameter
description
count
number of (filtered) tracking pixels
/conversions/codes/urls/list
access: [READ]
This method returns a list of tracking links related to a conversion code.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/codes/urls/list?id=025345de6ccc18c4709921e73e67a709&fields=count,url_id,alias
Query parameters
id = 025345de6ccc18c4709921e73e67a709
fields = count,url_id,alias
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 2 ,
"data" : [
{
"url_id" : "73e30d783b51e33bd82a158122734963" ,
"alias" : "64e496b8"
} ,
{
"url_id" : "04db30adb93ba38e7ec0df87504b0cd3" ,
"alias" : "580cd3ef"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/codes/urls/list?id=025345de6ccc18c4709921e73e67a709&fields=count,url_id,alias&format=xml
Query parameters
id = 025345de6ccc18c4709921e73e67a709
fields = count,url_id,alias
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 2 </count>
<data>
<i0>
<url_id> 73e30d783b51e33bd82a158122734963 </url_id>
<alias> 64e496b8 </alias>
</i0>
<i1>
<url_id> 04db30adb93ba38e7ec0df87504b0cd3 </url_id>
<alias> 580cd3ef </alias>
</i1>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/codes/urls/list?id=025345de6ccc18c4709921e73e67a709&fields=count,url_id,alias&format=txt
Query parameters
id = 025345de6ccc18c4709921e73e67a709
fields = count,url_id,alias
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 2
result_data_0_url_id = 73e30d783b51e33bd82a158122734963
result_data_0_alias = 64e496b8
result_data_1_url_id = 04db30adb93ba38e7ec0df87504b0cd3
result_data_1_alias = 580cd3ef
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/codes/urls/list?id=025345de6ccc18c4709921e73e67a709&fields=count,url_id,alias&format=plain
Query parameters
id = 025345de6ccc18c4709921e73e67a709
fields = count,url_id,alias
format = plain
Response
2
73e30d783b51e33bd82a158122734963
64e496b8
04db30adb93ba38e7ec0df87504b0cd3
580cd3ef
Required parameters
parameter
description
fieldsARRAY
comma-separated list of fields to return, available fields: count, url_id, alias, short_url, creation, long_url, domain_host, domain_id, project_name, project_id
idID
ID of the conversion code
Optional parameters
parameter
description
lengthINTEGER
extracts this number of tracking links (maxmimum allowed: 100)
orderbyARRAY
orders tracking links by field, available fields: url_id, alias, short_url, creation, long_url, domain_host, domain_id, project_name, project_id
searchSTRING
filters tracking links to be extracted by searching them
sortSTRING
sorts tracking links in ascending (ASC) or descending (DESC) order
startINTEGER
starts to extract tracking links from this position
Return values
parameter
description
count
[OPTIONAL] total number of tracking links, returned only if count is passed in fields
data
array containing information on the tracking links, the returned information depends on the fields parameter.
/conversions/count
access: [READ]
This method is actually an interface to i1/conversions/codes/count and/or to i1/conversions/pixels/count according to types .
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/count?types=code,pixel
Query parameters
types = code,pixel
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 32
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/count?types=code,pixel&format=xml
Query parameters
types = code,pixel
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 32 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/count?types=code,pixel&format=txt
Query parameters
types = code,pixel
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 32
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/count?types=code,pixel&format=plain
Query parameters
types = code,pixel
format = plain
Response
32
Required parameters
parameter
description
typesARRAY
comma separated list of types; available types are [code, pixel]
Return values
parameter
description
count
number of conversion, if both types are passed, it contains the sum of number of conversion codes and conversion pixels
/conversions/list
access: [READ]
This method is actually an interface to i1/conversions/codes/list and/or to i1/conversions/pixels/list according to types .
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url
Query parameters
types = code,pixel
fields = name,id,short_url
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : [
{
"name" : "conversion code 1 (postback enabled)" ,
"id" : "97be71796437a197e70519aabb95e1a3" ,
"ext_id" : "c96ccfc8819203f86e1f2a6427a09dac" ,
"ext_postback_id" : "bac6996492588c694a4a7c7686057052" ,
"type" : "code"
} ,
{
"name" : "conversion code 2" ,
"id" : "e5ff7baf60c674f84b52994351084ffc" ,
"ext_id" : "c7c64e17d70098f96804d63acf76eb22" ,
"type" : "code"
} ,
{
"id" : "ecab168a84ea69d8e178529507f5dca0" ,
"short_url" : "https:\/\/domain.ext\/tracking_pixel_alias" ,
"type" : "pixel"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url&format=xml
Query parameters
types = code,pixel
fields = name,id,short_url
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<i0>
<name> conversion code 1 (postback enabled) </name>
<id> 97be71796437a197e70519aabb95e1a3 </id>
<ext_id> c96ccfc8819203f86e1f2a6427a09dac </ext_id>
<ext_postback_id> bac6996492588c694a4a7c7686057052 </ext_postback_id>
<type> code </type>
</i0>
<i1>
<name> conversion code 2 </name>
<id> e5ff7baf60c674f84b52994351084ffc </id>
<ext_id> c7c64e17d70098f96804d63acf76eb22 </ext_id>
<type> code </type>
</i1>
<i2>
<id> ecab168a84ea69d8e178529507f5dca0 </id>
<short_url> https://domain.ext/tracking_pixel_alias </short_url>
<type> pixel </type>
</i2>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url&format=txt
Query parameters
types = code,pixel
fields = name,id,short_url
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_0_name = conversion code 1 (postback enabled)
result_data_0_id = 97be71796437a197e70519aabb95e1a3
result_data_0_ext_id = c96ccfc8819203f86e1f2a6427a09dac
result_data_0_ext_postback_id = bac6996492588c694a4a7c7686057052
result_data_0_type = code
result_data_1_name = conversion code 2
result_data_1_id = e5ff7baf60c674f84b52994351084ffc
result_data_1_ext_id = c7c64e17d70098f96804d63acf76eb22
result_data_1_type = code
result_data_2_id = ecab168a84ea69d8e178529507f5dca0
result_data_2_short_url = https://domain.ext/tracking_pixel_alias
result_data_2_type = pixel
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url&format=plain
Query parameters
types = code,pixel
fields = name,id,short_url
format = plain
Response
conversion code 1 (postback enabled)
97be71796437a197e70519aabb95e1a3
c96ccfc8819203f86e1f2a6427a09dac
bac6996492588c694a4a7c7686057052
code
conversion code 2
e5ff7baf60c674f84b52994351084ffc
c7c64e17d70098f96804d63acf76eb22
code
https://domain.ext/tracking_pixel_alias
Required parameters
parameter
description
typesARRAY
comma separated list of types; available types are [code, pixel]
Return values
parameter
description
count
[OPTIONAL] number of conversion, if both types are passed, it contains the sum of number of conversion codes and conversion pixels
data
array containing information on conversions
/conversions/pixels /conversions/pixels/add
access: [WRITE]
Add a tracking pixel for the logged user.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=16ec02ddd5d6a48ec72ac03c17518798&url_project_id=58db99a42ef655015aeffbcea0917e51¬es=
Query parameters
alias = jot
domain_id = 16ec02ddd5d6a48ec72ac03c17518798
url_project_id = 58db99a42ef655015aeffbcea0917e51
notes =
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "9633d958b3346c0598b13148eae7f4d1" ,
"alias" : "jot" ,
"domain_id" : "16ec02ddd5d6a48ec72ac03c17518798" ,
"domain_host" : "jo.my" ,
"domain_nickname" : "" ,
"url_project_id" : "58db99a42ef655015aeffbcea0917e51" ,
"project_name" : "project name" ,
"short_url" : "\/\/jo.my\/jot" ,
"template_type" : 2 ,
"notes" : ""
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=16ec02ddd5d6a48ec72ac03c17518798&url_project_id=58db99a42ef655015aeffbcea0917e51¬es=&format=xml
Query parameters
alias = jot
domain_id = 16ec02ddd5d6a48ec72ac03c17518798
url_project_id = 58db99a42ef655015aeffbcea0917e51
notes =
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 9633d958b3346c0598b13148eae7f4d1 </id>
<alias> jot </alias>
<domain_id> 16ec02ddd5d6a48ec72ac03c17518798 </domain_id>
<domain_host> jo.my </domain_host>
<domain_nickname> </domain_nickname>
<url_project_id> 58db99a42ef655015aeffbcea0917e51 </url_project_id>
<project_name> project name </project_name>
<short_url> //jo.my/jot </short_url>
<template_type> 2 </template_type>
<notes> </notes>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=16ec02ddd5d6a48ec72ac03c17518798&url_project_id=58db99a42ef655015aeffbcea0917e51¬es=&format=txt
Query parameters
alias = jot
domain_id = 16ec02ddd5d6a48ec72ac03c17518798
url_project_id = 58db99a42ef655015aeffbcea0917e51
notes =
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 9633d958b3346c0598b13148eae7f4d1
result_alias = jot
result_domain_id = 16ec02ddd5d6a48ec72ac03c17518798
result_domain_host = jo.my
result_domain_nickname =
result_url_project_id = 58db99a42ef655015aeffbcea0917e51
result_project_name = project name
result_short_url = //jo.my/jot
result_template_type = 2
result_notes =
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=16ec02ddd5d6a48ec72ac03c17518798&url_project_id=58db99a42ef655015aeffbcea0917e51¬es=&format=plain
Query parameters
alias = jot
domain_id = 16ec02ddd5d6a48ec72ac03c17518798
url_project_id = 58db99a42ef655015aeffbcea0917e51
notes =
format = plain
Response
//jo.my/jot
Required parameters
parameter
description
max length
aliasSTRING
alias for the tracking pixel, see i1/urls/shorten for details of available characters in alias
510
Optional parameters
parameter
description
conversion_idsARRAY_OF_IDS
ID of the associated conversion codes
domain_idID
ID of the domain for the tracking pixel, if not set the default domain for the user will be used
notesSTRING
notes for the tracking pixel
tagsARRAY
comma-separated list of tags for the tracking pixel
url_project_idID
ID of the project where the tracking pixel will be put in, if not specified the default : project is used
Return values
/conversions/pixels/count
access: [READ]
This method returns the number of defined conversion pixels.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/pixels/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 3
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/pixels/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 3 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/pixels/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 3
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/pixels/count?format=plain
Query parameters
format = plain
Response
3
Optional parameters
parameter
description
searchSTRING
filters conversion pixels to be extracted by searching them
Return values
parameter
description
count
number of (filtered) conversion pixels
/conversions/pixels/delete
access: [WRITE]
This method deletes a set of conversion pixel using their IDs.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198
Query parameters
ids = da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"deleted" : 3
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198&format=xml
Query parameters
ids = da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<deleted> 3 </deleted>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198&format=txt
Query parameters
ids = da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_deleted = 3
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198&format=plain
Query parameters
ids = da22d3e6a257275a71f933e2c3d296c7,33898be40e2ae1128ddfcfebb1532798,57c036d4a1d6bc1d98ec546b10440198
format = plain
Response
3
Example 5 (json)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b
Query parameters
ids = e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"ids" : [
"e266ea4144335a81e5fe39dda8a6e1e9"
] ,
"deleted" : 2
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b&format=xml
Query parameters
ids = e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<ids>
<i0> e266ea4144335a81e5fe39dda8a6e1e9 </i0>
</ids>
<deleted> 2 </deleted>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b&format=txt
Query parameters
ids = e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_ids_0 = e266ea4144335a81e5fe39dda8a6e1e9
result_deleted = 2
Example 8 (plain)
Request
https://joturl.com/a/i1/conversions/pixels/delete?ids=e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b&format=plain
Query parameters
ids = e266ea4144335a81e5fe39dda8a6e1e9,adc035f5a82b3a7239fc944048622c0f,6f86b2548a676333754faff23e8c979b
format = plain
Response
e266ea4144335a81e5fe39dda8a6e1e9
2
Required parameters
parameter
description
idsARRAY_OF_IDS
comma-separated list of tracking pixel IDs to be deleted
Return values
parameter
description
deleted
number of deleted tracking pixels
tracking_pixel_ids
[OPTIONAL] list of tracking pixel IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred
/conversions/pixels/edit
access: [WRITE]
Edit fields of a Tracking Pixel.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/pixels/edit?id=61f9f16fb35e9c4e85d4e687a1c294bf&alias=jot&domain_id=d0cb585eaef137198df8cb5519828d2a&url_project_id=aa85155c49ad6176a030a8e09c77a085¬es=new+notes
Query parameters
id = 61f9f16fb35e9c4e85d4e687a1c294bf
alias = jot
domain_id = d0cb585eaef137198df8cb5519828d2a
url_project_id = aa85155c49ad6176a030a8e09c77a085
notes = new notes
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "61f9f16fb35e9c4e85d4e687a1c294bf" ,
"alias" : "jot" ,
"domain_id" : "d0cb585eaef137198df8cb5519828d2a" ,
"domain_host" : "jo.my" ,
"domain_nickname" : "" ,
"url_project_id" : "aa85155c49ad6176a030a8e09c77a085" ,
"project_name" : "project name" ,
"short_url" : "\/\/jo.my\/jot" ,
"template_type" : 2 ,
"notes" : "new notes"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/pixels/edit?id=61f9f16fb35e9c4e85d4e687a1c294bf&alias=jot&domain_id=d0cb585eaef137198df8cb5519828d2a&url_project_id=aa85155c49ad6176a030a8e09c77a085¬es=new+notes&format=xml
Query parameters
id = 61f9f16fb35e9c4e85d4e687a1c294bf
alias = jot
domain_id = d0cb585eaef137198df8cb5519828d2a
url_project_id = aa85155c49ad6176a030a8e09c77a085
notes = new notes
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 61f9f16fb35e9c4e85d4e687a1c294bf </id>
<alias> jot </alias>
<domain_id> d0cb585eaef137198df8cb5519828d2a </domain_id>
<domain_host> jo.my </domain_host>
<domain_nickname> </domain_nickname>
<url_project_id> aa85155c49ad6176a030a8e09c77a085 </url_project_id>
<project_name> project name </project_name>
<short_url> //jo.my/jot </short_url>
<template_type> 2 </template_type>
<notes> new notes </notes>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/pixels/edit?id=61f9f16fb35e9c4e85d4e687a1c294bf&alias=jot&domain_id=d0cb585eaef137198df8cb5519828d2a&url_project_id=aa85155c49ad6176a030a8e09c77a085¬es=new+notes&format=txt
Query parameters
id = 61f9f16fb35e9c4e85d4e687a1c294bf
alias = jot
domain_id = d0cb585eaef137198df8cb5519828d2a
url_project_id = aa85155c49ad6176a030a8e09c77a085
notes = new notes
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 61f9f16fb35e9c4e85d4e687a1c294bf
result_alias = jot
result_domain_id = d0cb585eaef137198df8cb5519828d2a
result_domain_host = jo.my
result_domain_nickname =
result_url_project_id = aa85155c49ad6176a030a8e09c77a085
result_project_name = project name
result_short_url = //jo.my/jot
result_template_type = 2
result_notes = new notes
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/pixels/edit?id=61f9f16fb35e9c4e85d4e687a1c294bf&alias=jot&domain_id=d0cb585eaef137198df8cb5519828d2a&url_project_id=aa85155c49ad6176a030a8e09c77a085¬es=new+notes&format=plain
Query parameters
id = 61f9f16fb35e9c4e85d4e687a1c294bf
alias = jot
domain_id = d0cb585eaef137198df8cb5519828d2a
url_project_id = aa85155c49ad6176a030a8e09c77a085
notes = new notes
format = plain
Response
//jo.my/jot
Required parameters
parameter
description
idID
ID of the tracking pixel
Optional parameters
parameter
description
conversion_idsARRAY_OF_IDS
ID of the associated conversion codes
notesSTRING
notes for the tracking pixel
tagsARRAY
comma-separated list of tags for the tracking pixel
Return values
/conversions/pixels/info
access: [READ]
This method returns information specified in a comma separated input called fields about a conversion.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=3b043773eae9b64f4c8ff118a489637d
Query parameters
fields = id,short_url
id = 3b043773eae9b64f4c8ff118a489637d
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : [
{
"id" : "3b043773eae9b64f4c8ff118a489637d" ,
"short_url" : "http:\/\/jo.my\/c7fbd523"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=3b043773eae9b64f4c8ff118a489637d&format=xml
Query parameters
fields = id,short_url
id = 3b043773eae9b64f4c8ff118a489637d
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<i0>
<id> 3b043773eae9b64f4c8ff118a489637d </id>
<short_url> http://jo.my/c7fbd523 </short_url>
</i0>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=3b043773eae9b64f4c8ff118a489637d&format=txt
Query parameters
fields = id,short_url
id = 3b043773eae9b64f4c8ff118a489637d
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_0_id = 3b043773eae9b64f4c8ff118a489637d
result_data_0_short_url = http://jo.my/c7fbd523
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=3b043773eae9b64f4c8ff118a489637d&format=plain
Query parameters
fields = id,short_url
id = 3b043773eae9b64f4c8ff118a489637d
format = plain
Response
http://jo.my/c7fbd523
Required parameters
parameter
description
fieldsARRAY
comma separated list of fields to return, see method i1/conversions/pixels/list for reference
idID
ID of the tracking pixel whose information is required
Return values
parameter
description
data
array containing 1 item on success, the returned information depends on the fields parameter.
/conversions/pixels/list
access: [READ]
This method returns a list of tracking pixels.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=9093b3e56fc344007f11373410497714
Query parameters
fields = id,short_url
url_project_id = 9093b3e56fc344007f11373410497714
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : [
{
"id" : "3c79d7479c0c00bedc280be5da7fe240" ,
"short_url" : "http:\/\/jo.my\/3ea91252"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=9093b3e56fc344007f11373410497714&format=xml
Query parameters
fields = id,short_url
url_project_id = 9093b3e56fc344007f11373410497714
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<i0>
<id> 3c79d7479c0c00bedc280be5da7fe240 </id>
<short_url> http://jo.my/3ea91252 </short_url>
</i0>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=9093b3e56fc344007f11373410497714&format=txt
Query parameters
fields = id,short_url
url_project_id = 9093b3e56fc344007f11373410497714
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_0_id = 3c79d7479c0c00bedc280be5da7fe240
result_data_0_short_url = http://jo.my/3ea91252
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=9093b3e56fc344007f11373410497714&format=plain
Query parameters
fields = id,short_url
url_project_id = 9093b3e56fc344007f11373410497714
format = plain
Response
http://jo.my/3ea91252
Required parameters
parameter
description
fieldsARRAY
comma separated list of fields to return, available fields: count, id, short_url, creation, url_tags, clicks, unique_visits, qrcodes_visits, conversions_visits, notes, alias
Optional parameters
parameter
description
idID
ID of the tracking pixel
lengthINTEGER
extracts this number of items (maxmimum allowed: 100)
orderbyARRAY
orders items by field, available fields: count, id, short_url, creation, url_tags, clicks, unique_visits, qrcodes_visits, conversions_visits, notes, alias
searchSTRING
filters items to be extracted by searching them
sortSTRING
sorts items in ascending (ASC) or descending (DESC) order
startINTEGER
starts to extract items from this position
Return values
parameter
description
data
array containing information on the tracking pixels, the returned information depends on the fields parameter.
/conversions/settings /conversions/settings/get
access: [READ]
This method returns global setting for conversions.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/settings/get
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"last_or_first_click" : "last" ,
"expiration_cookie" : "30" ,
"currency_id" : "88dee24fd2bd783a4d48cf469c7b2b17"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/settings/get?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<last_or_first_click> last </last_or_first_click>
<expiration_cookie> 30 </expiration_cookie>
<currency_id> 88dee24fd2bd783a4d48cf469c7b2b17 </currency_id>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/settings/get?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_last_or_first_click = last
result_expiration_cookie = 30
result_currency_id = 88dee24fd2bd783a4d48cf469c7b2b17
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/settings/get?format=plain
Query parameters
format = plain
Response
last
30
88dee24fd2bd783a4d48cf469c7b2b17
Return values
parameter
description
currency_id
ID of the currency to apply to conversions, see i1/currencies/list for details
expiration_cookie
expiration period (in days) for conversion cookies
last_or_first_click
the click is assigned to the first
or last
click
/conversions/settings/property
access: [READ]
This method returns default values and properties for conversion settings.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/settings/property
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"default_last_or_first_click" : "last" ,
"default_expiration_cookie" : "30" ,
"default_currency_id" : "644a4b356f74446f62613864764b3762725a343966673d3d" ,
"default_clickbank_secret_key" : "" ,
"expiration_cookie_days" : [
1 ,
7 ,
30 ,
60 ,
90
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/settings/property?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<default_last_or_first_click> last </default_last_or_first_click>
<default_expiration_cookie> 30 </default_expiration_cookie>
<default_currency_id> 644a4b356f74446f62613864764b3762725a343966673d3d </default_currency_id>
<default_clickbank_secret_key> </default_clickbank_secret_key>
<expiration_cookie_days>
<i0> 1 </i0>
<i1> 7 </i1>
<i2> 30 </i2>
<i3> 60 </i3>
<i4> 90 </i4>
</expiration_cookie_days>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/settings/property?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_default_last_or_first_click = last
result_default_expiration_cookie = 30
result_default_currency_id = 644a4b356f74446f62613864764b3762725a343966673d3d
result_default_clickbank_secret_key =
result_expiration_cookie_days_0 = 1
result_expiration_cookie_days_1 = 7
result_expiration_cookie_days_2 = 30
result_expiration_cookie_days_3 = 60
result_expiration_cookie_days_4 = 90
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/settings/property?format=plain
Query parameters
format = plain
Response
last
30
644a4b356f74446f62613864764b3762725a343966673d3d
1
7
30
60
90
Return values
parameter
description
default_clickbank_secret_key
default ClickBank secret key
default_currency_id
default currency ID for the conversion, see i1/currencies/list for details
default_expiration_cookie
default expiration (in days) for the conversion cookie
default_last_or_first_click
default behavior for the click assignment
expiration_cookie_days
list of allowed expiration days
/conversions/settings/set
access: [WRITE]
This method sets global setting for conversions.
Example 1 (json)
Request
https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=a67e9590ad4c6e2223fbbbccf171fa0e&clickbank_secret_key=51D40E862650A3ED
Query parameters
last_or_first_click = last
expiration_cookie = 30
currency_id = a67e9590ad4c6e2223fbbbccf171fa0e
clickbank_secret_key = 51D40E862650A3ED
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"updated" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=a67e9590ad4c6e2223fbbbccf171fa0e&clickbank_secret_key=51D40E862650A3ED&format=xml
Query parameters
last_or_first_click = last
expiration_cookie = 30
currency_id = a67e9590ad4c6e2223fbbbccf171fa0e
clickbank_secret_key = 51D40E862650A3ED
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<updated> 1 </updated>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=a67e9590ad4c6e2223fbbbccf171fa0e&clickbank_secret_key=51D40E862650A3ED&format=txt
Query parameters
last_or_first_click = last
expiration_cookie = 30
currency_id = a67e9590ad4c6e2223fbbbccf171fa0e
clickbank_secret_key = 51D40E862650A3ED
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_updated = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=a67e9590ad4c6e2223fbbbccf171fa0e&clickbank_secret_key=51D40E862650A3ED&format=plain
Query parameters
last_or_first_click = last
expiration_cookie = 30
currency_id = a67e9590ad4c6e2223fbbbccf171fa0e
clickbank_secret_key = 51D40E862650A3ED
format = plain
Response
1
Required parameters
parameter
description
clickbank_secret_keySTRING
ClickBank secret key
currency_idID
ID of the currency to apply to conversions, see i1/currencies/list for details
expiration_cookieINTEGER
expiration period (in days) for conversion cookies, available values: 1, 7, 30, 60, 90
last_or_first_clickSTRING
assign a conversion to the first
or last
click made by the user on the tracking link/pixel
Return values
parameter
description
updated
1 on success, 0 otherwise
/ctas /ctas/count
access: [READ]
This method returns the number of defined call to actions.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 3
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 3 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 3
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/count?format=plain
Query parameters
format = plain
Response
3
Optional parameters
parameter
description
searchSTRING
filters CTAs to be extracted by searching them
typesSTRING
comma-separated list of types to filter CTAs, for available types see i1/ctas/property
Return values
parameter
description
count
number of (filtered) CTAs
/ctas/delete
access: [WRITE]
This method deletes a set of CTAs by using their IDs.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/delete?ids=ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0
Query parameters
ids = ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"deleted" : 3
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/delete?ids=ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0&format=xml
Query parameters
ids = ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<deleted> 3 </deleted>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/delete?ids=ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0&format=txt
Query parameters
ids = ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_deleted = 3
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/delete?ids=ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0&format=plain
Query parameters
ids = ff64cabb0fdcfab3b3b7721a1ddda932,c0738059600a0f2a75080e61f9d02c1e,95586fe2ef12bdd5c2a38add5b572ac0
format = plain
Response
3
Example 5 (json)
Request
https://joturl.com/a/i1/ctas/delete?ids=cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da
Query parameters
ids = cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"ids" : "cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15" ,
"deleted" : 1
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/ctas/delete?ids=cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da&format=xml
Query parameters
ids = cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<ids> cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15 </ids>
<deleted> 1 </deleted>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/ctas/delete?ids=cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da&format=txt
Query parameters
ids = cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_ids = cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15
result_deleted = 1
Example 8 (plain)
Request
https://joturl.com/a/i1/ctas/delete?ids=cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da&format=plain
Query parameters
ids = cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15,9024f7d439ae6ab3ad4a156fa71785da
format = plain
Response
cc245c79c777ebf9196f6b409460a7d2,9b8a5b2bb1652c24ee8622c913685a15
1
Required parameters
parameter
description
idsARRAY_OF_IDS
comma separated list of CTA IDs to be deleted
Return values
parameter
description
deleted
number of deleted CTAs
ids
[OPTIONAL] list of CTA IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred
/ctas/download
access: [READ]
This method returns data that is collected for a specific CTA. Only data collected in the last 90 days can be returned.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"headers" : [
"name" ,
"age" ,
"email"
] ,
"lines" : [
[
"John" ,
"27" ,
"john@example.com"
] ,
[
"Doo" ,
"31" ,
"doo@example.com"
]
] ,
"extracted" : 2 ,
"skipped" : 3 ,
"count" : 5 ,
"next" : ""
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c&format=xml
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<headers>
<i0> name </i0>
<i1> age </i1>
<i2> email </i2>
</headers>
<lines>
<i0>
<i0> John </i0>
<i1> 27 </i1>
<i2> john@example.com </i2>
</i0>
<i1>
<i0> Doo </i0>
<i1> 31 </i1>
<i2> doo@example.com </i2>
</i1>
</lines>
<extracted> 2 </extracted>
<skipped> 3 </skipped>
<count> 5 </count>
<next> </next>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c&format=txt
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_headers_0 = name
result_headers_1 = age
result_headers_2 = email
result_lines_0_0 = John
result_lines_0_1 = 27
result_lines_0_2 = john@example.com
result_lines_1_0 = Doo
result_lines_1_1 = 31
result_lines_1_2 = doo@example.com
result_extracted = 2
result_skipped = 3
result_count = 5
result_next =
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c&format=plain
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
format = plain
Response
name
age
email
John
27
john@example.com
Doo
31
doo@example.com
2
3
5
Example 5 (json)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c&return_json=1
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
return_json = 1
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : [
{
"name" : "John" ,
"age" : "27" ,
"email" : "john@example.com"
} ,
{
"name" : "Doo" ,
"age" : "31" ,
"email" : "doo@example.com"
}
] ,
"extracted" : 2 ,
"skipped" : 3 ,
"count" : 5 ,
"next" : ""
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c&return_json=1&format=xml
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
return_json = 1
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<i0>
<name> John </name>
<age> 27 </age>
<email> john@example.com </email>
</i0>
<i1>
<name> Doo </name>
<age> 31 </age>
<email> doo@example.com </email>
</i1>
</data>
<extracted> 2 </extracted>
<skipped> 3 </skipped>
<count> 5 </count>
<next> </next>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c&return_json=1&format=txt
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
return_json = 1
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_0_name = John
result_data_0_age = 27
result_data_0_email = john@example.com
result_data_1_name = Doo
result_data_1_age = 31
result_data_1_email = doo@example.com
result_extracted = 2
result_skipped = 3
result_count = 5
result_next =
Example 8 (plain)
Request
https://joturl.com/a/i1/ctas/download?id=20c6932fe769e3ac4d60cf888e58299c&return_json=1&format=plain
Query parameters
id = 20c6932fe769e3ac4d60cf888e58299c
return_json = 1
format = plain
Response
John
27
john@example.com
Doo
31
doo@example.com
2
3
5
Required parameters
parameter
description
idID
ID of the call to action
Optional parameters
parameter
description
from_dateDATE
date (inclusive) from which to start the export (default: 90 days before today)
lengthINTEGER
number of items to return (default: 1000, max value: 1000)
return_jsonBOOLEAN
if 1 this method returns a JSON data
fields instead of headers
and lines
fields (default: 0)
sampleBOOLEAN
1 to return sample data, 0 otherwise (default: 0)
startINTEGER
index of the starting item to retrieve (default: 0)
to_dateDATE
date (inclusive) to finish the export (default: today)
Return values
parameter
description
count
maximum number of items
data
[OPTIONAL] alternative to headers
and lines
, returned if return_json=1
extracted
number of extracted items
headers
[OPTIONAL] names of the corresponding information returned in lines, returned if return_json=0
lines
[OPTIONAL] array containing information of the CTA data, returned if return_json=0
next
URL to be called in order to fetch the next page of the list
skipped
number of skipped items
/ctas/socialapps /ctas/socialapps/add
access: [WRITE]
Add a new social app.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=99fba987a33e4da256b9098f2f74a94c&secret=f4f70b6b7341f1831750196dc9be5036
Query parameters
provider = facebook
name = my custom social app
appid = 99fba987a33e4da256b9098f2f74a94c
secret = f4f70b6b7341f1831750196dc9be5036
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"provider" : "facebook" ,
"id" : "d954fa8418743a9a60d0bab7c59bb7a0" ,
"name" : "my custom social app" ,
"appid" : "99fba987a33e4da256b9098f2f74a94c"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=99fba987a33e4da256b9098f2f74a94c&secret=f4f70b6b7341f1831750196dc9be5036&format=xml
Query parameters
provider = facebook
name = my custom social app
appid = 99fba987a33e4da256b9098f2f74a94c
secret = f4f70b6b7341f1831750196dc9be5036
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<provider> facebook </provider>
<id> d954fa8418743a9a60d0bab7c59bb7a0 </id>
<name> my custom social app </name>
<appid> 99fba987a33e4da256b9098f2f74a94c </appid>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=99fba987a33e4da256b9098f2f74a94c&secret=f4f70b6b7341f1831750196dc9be5036&format=txt
Query parameters
provider = facebook
name = my custom social app
appid = 99fba987a33e4da256b9098f2f74a94c
secret = f4f70b6b7341f1831750196dc9be5036
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_provider = facebook
result_id = d954fa8418743a9a60d0bab7c59bb7a0
result_name = my custom social app
result_appid = 99fba987a33e4da256b9098f2f74a94c
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=99fba987a33e4da256b9098f2f74a94c&secret=f4f70b6b7341f1831750196dc9be5036&format=plain
Query parameters
provider = facebook
name = my custom social app
appid = 99fba987a33e4da256b9098f2f74a94c
secret = f4f70b6b7341f1831750196dc9be5036
format = plain
Response
facebook
d954fa8418743a9a60d0bab7c59bb7a0
my custom social app
99fba987a33e4da256b9098f2f74a94c
Required parameters
parameter
description
max length
appidSTRING
social app ID/Key/Client ID
255
nameSTRING
name of the social app
255
providerSTRING
name of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph
50
secretSTRING
social app secret
255
Return values
parameter
description
appid
social app ID/Key/Client ID
id
ID of the social app
name
name of the social app
provider
name of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph
/ctas/socialapps/count
access: [READ]
This method returns the number of defined social apps.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 5
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 5 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 5
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/count?format=plain
Query parameters
format = plain
Response
5
Example 5 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/count?search=test
Query parameters
search = test
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 3
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/count?search=test&format=xml
Query parameters
search = test
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 3 </count>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/count?search=test&format=txt
Query parameters
search = test
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 3
Example 8 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/count?search=test&format=plain
Query parameters
search = test
format = plain
Response
3
Optional parameters
parameter
description
max length
providerSTRING
name of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph
50
searchSTRING
count items by searching them
Return values
parameter
description
count
number of social apps the user has access to (filtered by search if passed)
/ctas/socialapps/delete
access: [WRITE]
Delete a social app.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4
Query parameters
ids = bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"deleted" : 2
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4&format=xml
Query parameters
ids = bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<deleted> 2 </deleted>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4&format=txt
Query parameters
ids = bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_deleted = 2
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4&format=plain
Query parameters
ids = bdaa56525cdd1b68ac2b9a58e7669354,c43725ed4304dc1ad63fac25715057b4
format = plain
Response
2
Example 5 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48
Query parameters
ids = a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"ids" : "a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf" ,
"deleted" : 1
}
}
Example 6 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48&format=xml
Query parameters
ids = a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<ids> a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf </ids>
<deleted> 1 </deleted>
</result>
</response>
Example 7 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48&format=txt
Query parameters
ids = a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_ids = a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf
result_deleted = 1
Example 8 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/delete?ids=a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48&format=plain
Query parameters
ids = a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf,0a66a58a4be8646f45eafe7787a15e48
format = plain
Response
a8796cffbf9bbc73e7a973d5f4baeaa1,6cc7012035d7e1f2e88e65daa8ea4adf
1
Required parameters
parameter
description
idsARRAY_OF_IDS
comma separated list of social app IDs to be deleted
Optional parameters
parameter
description
confirmBOOLEAN
1 to force the cancellation of social apps even if in use (default: 0)
Return values
parameter
description
deleted
number of deleted social apps
ids
[OPTIONAL] list of social app IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred
/ctas/socialapps/edit
access: [WRITE]
Edit a social app.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=7e79d2240890887eee874f660a8f21c6
Query parameters
provider = facebook
name = social app name
appid = 7e79d2240890887eee874f660a8f21c6
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "880f8b55ef0aa9d386f1b3f43e582055" ,
"provider" : "facebook" ,
"name" : "social app name" ,
"appid" : "7e79d2240890887eee874f660a8f21c6"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=7e79d2240890887eee874f660a8f21c6&format=xml
Query parameters
provider = facebook
name = social app name
appid = 7e79d2240890887eee874f660a8f21c6
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 880f8b55ef0aa9d386f1b3f43e582055 </id>
<provider> facebook </provider>
<name> social app name </name>
<appid> 7e79d2240890887eee874f660a8f21c6 </appid>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=7e79d2240890887eee874f660a8f21c6&format=txt
Query parameters
provider = facebook
name = social app name
appid = 7e79d2240890887eee874f660a8f21c6
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 880f8b55ef0aa9d386f1b3f43e582055
result_provider = facebook
result_name = social app name
result_appid = 7e79d2240890887eee874f660a8f21c6
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=7e79d2240890887eee874f660a8f21c6&format=plain
Query parameters
provider = facebook
name = social app name
appid = 7e79d2240890887eee874f660a8f21c6
format = plain
Response
880f8b55ef0aa9d386f1b3f43e582055
facebook
social app name
7e79d2240890887eee874f660a8f21c6
Required parameters
parameter
description
idID
ID of the social app
Optional parameters
parameter
description
max length
appidSTRING
social app ID/Key/Client ID
255
nameSTRING
name of the social app
255
providerSTRING
name of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph
50
secretSTRING
social app secret
255
Return values
parameter
description
appid
social app ID/Key/Client ID
id
ID of the social app
name
name of the social app
provider
name of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph
/ctas/socialapps/info
access: [READ]
This method returns information on a social app.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/info?id=50d4b7ea244e2817842ce42e8fb18ac8
Query parameters
id = 50d4b7ea244e2817842ce42e8fb18ac8
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "50d4b7ea244e2817842ce42e8fb18ac8" ,
"provider" : "facebook" ,
"name" : "this is my app name" ,
"appid" : "d4f2313471d8c23b4238b29c15160b98"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/info?id=50d4b7ea244e2817842ce42e8fb18ac8&format=xml
Query parameters
id = 50d4b7ea244e2817842ce42e8fb18ac8
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 50d4b7ea244e2817842ce42e8fb18ac8 </id>
<provider> facebook </provider>
<name> this is my app name </name>
<appid> d4f2313471d8c23b4238b29c15160b98 </appid>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/info?id=50d4b7ea244e2817842ce42e8fb18ac8&format=txt
Query parameters
id = 50d4b7ea244e2817842ce42e8fb18ac8
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 50d4b7ea244e2817842ce42e8fb18ac8
result_provider = facebook
result_name = this is my app name
result_appid = d4f2313471d8c23b4238b29c15160b98
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/info?id=50d4b7ea244e2817842ce42e8fb18ac8&format=plain
Query parameters
id = 50d4b7ea244e2817842ce42e8fb18ac8
format = plain
Response
50d4b7ea244e2817842ce42e8fb18ac8
facebook
this is my app name
d4f2313471d8c23b4238b29c15160b98
Required parameters
parameter
description
idID
ID of the social app
Return values
parameter
description
appid
social app ID/Key/Client ID
id
ID of the social app
name
name of the social app
provider
name of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph
/ctas/socialapps/list
access: [READ]
This method returns a list of social apps.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/list
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 1 ,
"data" : {
"id" : "c0ede36990dcad8c35c83cfa1ef3773f" ,
"provider" : "facebook" ,
"name" : "this is my app name" ,
"appid" : "309f3b887e862ef55c6585a6051e55b0"
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/list?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 1 </count>
<data>
<id> c0ede36990dcad8c35c83cfa1ef3773f </id>
<provider> facebook </provider>
<name> this is my app name </name>
<appid> 309f3b887e862ef55c6585a6051e55b0 </appid>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/list?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 1
result_data_id = c0ede36990dcad8c35c83cfa1ef3773f
result_data_provider = facebook
result_data_name = this is my app name
result_data_appid = 309f3b887e862ef55c6585a6051e55b0
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/list?format=plain
Query parameters
format = plain
Response
1
c0ede36990dcad8c35c83cfa1ef3773f
facebook
this is my app name
309f3b887e862ef55c6585a6051e55b0
Optional parameters
parameter
description
max length
lengthINTEGER
extracts this number of items (maxmimum allowed: 100)
orderbyARRAY
orders items by field, available fields: start, length, search, orderby, sort, provider, format, callback
providerSTRING
filter social apps by provider, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph
50
searchSTRING
filters items to be extracted by searching them
sortSTRING
sorts items in ascending (ASC) or descending (DESC) order
startINTEGER
starts to extract items from this position
Return values
parameter
description
count
total number of social apps
data
array containing information on social apps the user has access to
/ctas/socialapps/property
access: [READ]
Returns the supported social app providers.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/socialapps/property
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : {
"providers" : [
"amazon" ,
"facebook" ,
"google" ,
"linkedin" ,
"microsoftgraph" ,
"twitter"
]
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/socialapps/property?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<providers>
<i0> amazon </i0>
<i1> facebook </i1>
<i2> google </i2>
<i3> linkedin </i3>
<i4> microsoftgraph </i4>
<i5> twitter </i5>
</providers>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/socialapps/property?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_providers_0 = amazon
result_data_providers_1 = facebook
result_data_providers_2 = google
result_data_providers_3 = linkedin
result_data_providers_4 = microsoftgraph
result_data_providers_5 = twitter
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/socialapps/property?format=plain
Query parameters
format = plain
Response
amazon
facebook
google
linkedin
microsoftgraph
twitter
Return values
parameter
description
data
list of supported social apps
Currently supported apps: amazon, facebook, google, linkedin, microsoftgraph, twitter.
/ctas/urls /ctas/urls/count
access: [READ]
This method returns the number of user's urls related to a call to action.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/urls/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 2
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/urls/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 2 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/urls/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 2
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/urls/count?format=plain
Query parameters
format = plain
Response
2
Required parameters
parameter
description
cta_idID
ID of the CTA
Optional parameters
parameter
description
searchSTRING
filters tracking pixels to be extracted by searching them
Return values
parameter
description
count
number of (filtered) tracking pixels
/ctas/urls/list
access: [READ]
This method returns a list of user's urls data related to a call to action.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/urls/list?id=a740037998d0cec73182677b66a44094&fields=count,id,url_url
Query parameters
id = a740037998d0cec73182677b66a44094
fields = count,id,url_url
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 1 ,
"data" : [
{
"id" : "c17d3c4a132a2542a1eee096dc91d8b0" ,
"url_url" : "d2e898e5"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/urls/list?id=a740037998d0cec73182677b66a44094&fields=count,id,url_url&format=xml
Query parameters
id = a740037998d0cec73182677b66a44094
fields = count,id,url_url
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 1 </count>
<data>
<i0>
<id> c17d3c4a132a2542a1eee096dc91d8b0 </id>
<url_url> d2e898e5 </url_url>
</i0>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/urls/list?id=a740037998d0cec73182677b66a44094&fields=count,id,url_url&format=txt
Query parameters
id = a740037998d0cec73182677b66a44094
fields = count,id,url_url
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 1
result_data_0_id = c17d3c4a132a2542a1eee096dc91d8b0
result_data_0_url_url = d2e898e5
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/urls/list?id=a740037998d0cec73182677b66a44094&fields=count,id,url_url&format=plain
Query parameters
id = a740037998d0cec73182677b66a44094
fields = count,id,url_url
format = plain
Response
1
c17d3c4a132a2542a1eee096dc91d8b0
d2e898e5
Required parameters
parameter
description
cta_idID
ID of the CTA
fieldsARRAY
comma-separated list of fields to return, available fields: count, id, url_url, short_url, url_creation, url, has_preview, domain_extended_name, domain_id, project_name, project_is_default, project_id
Optional parameters
parameter
description
lengthINTEGER
extracts this number of tracking links (maxmimum allowed: 100)
orderbyARRAY
orders tracking links by field, available fields: id, url_url, short_url, url_creation, url, has_preview, domain_extended_name, domain_id, project_name, project_is_default, project_id
searchSTRING
filters tracking links to be extracted by searching them
sortSTRING
sorts tracking links in ascending (ASC) or descending (DESC) order
startINTEGER
starts to extract tracking links from this position
Return values
parameter
description
count
[OPTIONAL] total number of tracking links, returned only if count is passed in fields
data
array containing information on the tracking links, the returned information depends on the fields parameter.
/ctas/webhooks /ctas/webhooks/info
access: [READ]
This method return information on a webhook.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/webhooks/info?id=90c46bbf6da6158863cecc2287d8d7d4
Query parameters
id = 90c46bbf6da6158863cecc2287d8d7d4
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "90c46bbf6da6158863cecc2287d8d7d4" ,
"url" : "https:\/\/my.custom.webhook\/" ,
"type" : "custom" ,
"info" : [] ,
"notes" : ""
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/webhooks/info?id=90c46bbf6da6158863cecc2287d8d7d4&format=xml
Query parameters
id = 90c46bbf6da6158863cecc2287d8d7d4
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 90c46bbf6da6158863cecc2287d8d7d4 </id>
<url> https://my.custom.webhook/ </url>
<type> custom </type>
<info>
</info>
<notes> </notes>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/webhooks/info?id=90c46bbf6da6158863cecc2287d8d7d4&format=txt
Query parameters
id = 90c46bbf6da6158863cecc2287d8d7d4
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 90c46bbf6da6158863cecc2287d8d7d4
result_url = https://my.custom.webhook/
result_type = custom
result_info =
result_notes =
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/webhooks/info?id=90c46bbf6da6158863cecc2287d8d7d4&format=plain
Query parameters
id = 90c46bbf6da6158863cecc2287d8d7d4
format = plain
Response
90c46bbf6da6158863cecc2287d8d7d4
https://my.custom.webhook/
custom
Required parameters
parameter
description
idID
ID of the CTA from which to remove the webhook
Return values
parameter
description
id
echo back of the id
input parameter
info
extended info of the webhook
notes
notes for the webhook
type
webhook type, see i1/ctas/webhooks/property for details
url
URL of the webhook
when type = zapier
, the returned parameter url
is empty
/ctas/webhooks/property
access: [READ]
Return available webhook types and their parameters.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite
Query parameters
types = custom,zapier,mailerlite
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : {
"custom" : {
"name" : "Custom webhook" ,
"private" : 0 ,
"url_required" : 1 ,
"info" : {
"home" : "https:\/\/joturl.zendesk.com\/hc\/en-us\/articles\/360012882199" ,
"logo" : "data:image\/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg=="
} ,
"parameters" : [
{
"name" : "fields" ,
"type" : "json" ,
"maxlength" : 2000 ,
"description" : "couples key\/values" ,
"mandatory" : 0 ,
"example" : "{\"source\":\"joturl\",\"test\":1}"
}
]
} ,
"mailerlite" : {
"name" : "MailerLite" ,
"private" : 0 ,
"url_required" : 0 ,
"info" : {
"home" : "https:\/\/www.mailerlite.com\/" ,
"logo" : "https:\/\/www.mailerlite.com\/assets\/logo-color.png"
} ,
"parameters" : [
{
"name" : "apikey" ,
"type" : "string" ,
"maxlength" : 500 ,
"description" : "MailerLite API key" ,
"documentation" : "https:\/\/help.mailerlite.com\/article\/show\/35040-where-can-i-find-the-api-key" ,
"mandatory" : 1 ,
"example" : "613d01b8670662bc638f4c9bed2cfdf4"
} ,
{
"name" : "group" ,
"type" : "string" ,
"maxlength" : 500 ,
"description" : "GroupID of the MailerLite group" ,
"documentation" : "https:\/\/app.mailerlite.com\/subscribe\/api" ,
"mandatory" : 1 ,
"example" : "985114017"
} ,
{
"name" : "fields" ,
"type" : "json" ,
"maxlength" : 2000 ,
"description" : "couples key\/values" ,
"mandatory" : 0 ,
"example" : "{\"source\":\"joturl\",\"test\":1}"
}
]
} ,
"zapier" : {
"name" : "Zapier" ,
"private" : 1 ,
"url_required" : 0 ,
"info" : {
"home" : "https:\/\/zapier.com\/" ,
"logo" : "https:\/\/cdn.zapier.com\/zapier\/images\/logos\/zapier-logo.png"
} ,
"parameters" : []
}
}
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite&format=xml
Query parameters
types = custom,zapier,mailerlite
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<custom>
<name> Custom webhook </name>
<private> 0 </private>
<url_required> 1 </url_required>
<info>
<home> https://joturl.zendesk.com/hc/en-us/articles/360012882199 </home>
<logo> data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg== </logo>
</info>
<parameters>
<i0>
<name> fields </name>
<type> json </type>
<maxlength> 2000 </maxlength>
<description> couples key/values </description>
<mandatory> 0 </mandatory>
<example> {"source":"joturl","test":1} </example>
</i0>
</parameters>
</custom>
<mailerlite>
<name> MailerLite </name>
<private> 0 </private>
<url_required> 0 </url_required>
<info>
<home> https://www.mailerlite.com/ </home>
<logo> https://www.mailerlite.com/assets/logo-color.png </logo>
</info>
<parameters>
<i0>
<name> apikey </name>
<type> string </type>
<maxlength> 500 </maxlength>
<description> MailerLite API key </description>
<documentation> https://help.mailerlite.com/article/show/35040-where-can-i-find-the-api-key </documentation>
<mandatory> 1 </mandatory>
<example> 613d01b8670662bc638f4c9bed2cfdf4 </example>
</i0>
<i1>
<name> group </name>
<type> string </type>
<maxlength> 500 </maxlength>
<description> GroupID of the MailerLite group </description>
<documentation> https://app.mailerlite.com/subscribe/api </documentation>
<mandatory> 1 </mandatory>
<example> 985114017 </example>
</i1>
<i2>
<name> fields </name>
<type> json </type>
<maxlength> 2000 </maxlength>
<description> couples key/values </description>
<mandatory> 0 </mandatory>
<example> {"source":"joturl","test":1} </example>
</i2>
</parameters>
</mailerlite>
<zapier>
<name> Zapier </name>
<private> 1 </private>
<url_required> 0 </url_required>
<info>
<home> https://zapier.com/ </home>
<logo> https://cdn.zapier.com/zapier/images/logos/zapier-logo.png </logo>
</info>
<parameters>
</parameters>
</zapier>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite&format=txt
Query parameters
types = custom,zapier,mailerlite
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_custom_name = Custom webhook
result_data_custom_private = 0
result_data_custom_url_required = 1
result_data_custom_info_home = https://joturl.zendesk.com/hc/en-us/articles/360012882199
result_data_custom_info_logo = data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==
result_data_custom_parameters_0_name = fields
result_data_custom_parameters_0_type = json
result_data_custom_parameters_0_maxlength = 2000
result_data_custom_parameters_0_description = couples key/values
result_data_custom_parameters_0_mandatory = 0
result_data_custom_parameters_0_example = {"source":"joturl","test":1}
result_data_mailerlite_name = MailerLite
result_data_mailerlite_private = 0
result_data_mailerlite_url_required = 0
result_data_mailerlite_info_home = https://www.mailerlite.com/
result_data_mailerlite_info_logo = https://www.mailerlite.com/assets/logo-color.png
result_data_mailerlite_parameters_0_name = apikey
result_data_mailerlite_parameters_0_type = string
result_data_mailerlite_parameters_0_maxlength = 500
result_data_mailerlite_parameters_0_description = MailerLite API key
result_data_mailerlite_parameters_0_documentation = https://help.mailerlite.com/article/show/35040-where-can-i-find-the-api-key
result_data_mailerlite_parameters_0_mandatory = 1
result_data_mailerlite_parameters_0_example = 613d01b8670662bc638f4c9bed2cfdf4
result_data_mailerlite_parameters_1_name = group
result_data_mailerlite_parameters_1_type = string
result_data_mailerlite_parameters_1_maxlength = 500
result_data_mailerlite_parameters_1_description = GroupID of the MailerLite group
result_data_mailerlite_parameters_1_documentation = https://app.mailerlite.com/subscribe/api
result_data_mailerlite_parameters_1_mandatory = 1
result_data_mailerlite_parameters_1_example = 985114017
result_data_mailerlite_parameters_2_name = fields
result_data_mailerlite_parameters_2_type = json
result_data_mailerlite_parameters_2_maxlength = 2000
result_data_mailerlite_parameters_2_description = couples key/values
result_data_mailerlite_parameters_2_mandatory = 0
result_data_mailerlite_parameters_2_example = {"source":"joturl","test":1}
result_data_zapier_name = Zapier
result_data_zapier_private = 1
result_data_zapier_url_required = 0
result_data_zapier_info_home = https://zapier.com/
result_data_zapier_info_logo = https://cdn.zapier.com/zapier/images/logos/zapier-logo.png
result_data_zapier_parameters =
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite&format=plain
Query parameters
types = custom,zapier,mailerlite
format = plain
Response
Custom webhook
0
1
https://joturl.zendesk.com/hc/en-us/articles/360012882199
data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==
fields
json
2000
couples key/values
0
{"source":"joturl","test":1}
MailerLite
0
0
https://www.mailerlite.com/
https://www.mailerlite.com/assets/logo-color.png
apikey
string
500
MailerLite API key
https://help.mailerlite.com/article/show/35040-where-can-i-find-the-api-key
1
613d01b8670662bc638f4c9bed2cfdf4
group
string
500
GroupID of the MailerLite group
https://app.mailerlite.com/subscribe/api
1
985114017
fields
json
2000
couples key/values
0
{"source":"joturl","test":1}
Zapier
1
0
https://zapier.com/
https://cdn.zapier.com/zapier/images/logos/zapier-logo.png
Optional parameters
parameter
description
typesSTRING
comma-separated list of webhook types to be returned, if empty all types are returned, available types: activecampaign
, custom
, drift
, getresponse
, hubspot
, mailchimp
, mailerlite
, mailjet
, mautic
, moosend
, sendinblue
, zapier
Return values
parameter
description
data
array containing information on webhook parameters by type
Check the following tables for information on webhook parameters by type.
ActiveCampaign type = activecampaign
name description help mandatory type max length example apiurl ActiveCampaign API Access URL Yes url 4000 https://your-account.api-us1.com apikey ActiveCampaign API Access Key Yes string 500 93f5b9d537e3474182daf09a3523bc32 list ActiveCampaign list ID, if not specified the email will be added to global contacts No string 500 769042435
Custom webhook type = custom
name description help mandatory type max length example fields couples key/values No json 2000 {"source":"joturl","test":1}
Drift type = drift
name description help mandatory type max length example apitoken Drift Personal API Token Yes string 500 14049e622bcf0ae8715a00dc4c3ef757 fields couples key/values No json 2000 {"source":"joturl","test":1}
GetResponse type = getresponse
name description help mandatory type max length example apikey GetResponse API key Yes string 500 c1ddf341c2d1267b6f4d34080067f8e6 list GetResponse list token Yes string 500 ZgNiw
HubSpot type = hubspot
name description help mandatory type max length example apikey HubSpot API Access Key Yes string 500 2d04c79bf64d1f89b51ee633ac3fcab0 list HubSpot list ID, if not specified the email will be added to global contacts No string 500 1981362554 properties properties (key/value pairs), each property must exist on HubSpot otherwise the API call will fail No json 2000 {"source":"joturl","test":1}
Mailchimp type = mailchimp
name description help mandatory type max length example apikey Mailchimp API key Yes string 500 b1520be4fb949e50f4cc6cf5bbef3ac6 audience ID of the Mailchimp audience Yes string 500 696fdf2d fields couples key/values No json 2000 {"source":"joturl","test":1}
MailerLite type = mailerlite
name description help mandatory type max length example apikey MailerLite API key Yes string 500 a3939310aff638258d4f6656d615f8a1 group GroupID of the MailerLite group Yes string 500 1769302458 fields couples key/values No json 2000 {"source":"joturl","test":1}
Mailjet type = mailjet
name description help mandatory type max length example apikey Mailjet API key Yes string 500 2dff03b1c05faee611762ade001d8a1c secretkey Mailjet secret key Yes string 500 8de92c150c713e10dcf46083fdf32e0c list Mailjet contact list ID, if not specified the email will be added to global contacts No string 500 290916634
Mautic type = mautic
name description help mandatory type max length example apiurl Your Mautic API base URL Yes url 4000 https://your-mautic.com username Mautic username Yes string 500 6e33323f8c8258c8b5deb112515a7256 password Mautic password Yes string 500 59a4f8ac330b05035af2992cda10b724 fields couples key/values No json 2000 {"source":"joturl","test":1}
Moosend type = moosend
name description help mandatory type max length example apikey Moosend API key Yes string 500 bafe55f4-e53e-4651-8164-c6d6ff05081b mailingListID Moosend ID of the mailing list to add the new member Yes string 500 a589366a-1a34-4965-ac50-f1299fe5979e fields couples key/values No json 2000 {"source":"joturl","test":1}
Sendinblue type = sendinblue
name description help mandatory type max length example apikey Sendinblue API key (v3) Yes string 500 8184f355e978f0ce8add9a2e958f52b4 list Sendinblue list ID, if not specified the email will be added to global contacts No string 500 1085425446 firstname Sendinblue "attribute name" for the contact's first name No string 500 FNAME lastname Sendinblue "attribute name" for the contact's last name No string 500 LNAME fullname Sendinblue "attribute name" for the contact's full name No string 500 FULLNAME fields couples key/values No json 2000 {"source":"joturl","test":1}
Zapier type = zapier
This type of webhook cannot be directly subscribed, please use our Zapier integration.
/ctas/webhooks/subscribe
access: [WRITE]
This method add a webhook subscription to a CTA.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/webhooks/subscribe?id=e26b2544d77d53f78f78befe7f11b0b8&url=https%3A%2F%2Fjoturl.com%2F
Query parameters
id = e26b2544d77d53f78f78befe7f11b0b8
url = https://joturl.com/
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"added" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/webhooks/subscribe?id=e26b2544d77d53f78f78befe7f11b0b8&url=https%3A%2F%2Fjoturl.com%2F&format=xml
Query parameters
id = e26b2544d77d53f78f78befe7f11b0b8
url = https://joturl.com/
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<added> 1 </added>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/webhooks/subscribe?id=e26b2544d77d53f78f78befe7f11b0b8&url=https%3A%2F%2Fjoturl.com%2F&format=txt
Query parameters
id = e26b2544d77d53f78f78befe7f11b0b8
url = https://joturl.com/
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_added = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/webhooks/subscribe?id=e26b2544d77d53f78f78befe7f11b0b8&url=https%3A%2F%2Fjoturl.com%2F&format=plain
Query parameters
id = e26b2544d77d53f78f78befe7f11b0b8
url = https://joturl.com/
format = plain
Response
1
Required parameters
parameter
description
idID
ID of the CTA to which to add the webhook
typeSTRING
webhook type, allowed types: activecampaign
, custom
, drift
, getresponse
, hubspot
, mailchimp
, mailerlite
, mailjet
, mautic
, moosend
, sendinblue
, zapier
Optional parameters
parameter
description
max length
infoJSON
info to be used with the webhook (e.g., an API key), see below for details
notesSTRING
notes for the webhook
4000
unsubscribeBOOLEAN
1 to unsubscribe from the current webhook (if any) and subscribe to the new one
urlSTRING
URL of the webhook, required for types: custom
, zapier
4000
Return values
parameter
description
added
1 on success, 0 otherwise
/ctas/webhooks/test
access: [WRITE]
This endpoint sends test data to a CTA webhook.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/webhooks/test?id=676e540271687344971e8130577dc6d6
Query parameters
id = 676e540271687344971e8130577dc6d6
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"ok" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/webhooks/test?id=676e540271687344971e8130577dc6d6&format=xml
Query parameters
id = 676e540271687344971e8130577dc6d6
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<ok> 1 </ok>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/webhooks/test?id=676e540271687344971e8130577dc6d6&format=txt
Query parameters
id = 676e540271687344971e8130577dc6d6
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_ok = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/webhooks/test?id=676e540271687344971e8130577dc6d6&format=plain
Query parameters
id = 676e540271687344971e8130577dc6d6
format = plain
Response
1
Required parameters
parameter
description
idID
ID of the CTA associated with the webhook
Return values
parameter
description
ok
1 on success, otherwise an error is returned
/ctas/webhooks/unsubscribe
access: [WRITE]
This method removes a webhook subscription to a CTA.
Example 1 (json)
Request
https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=8915c3253d0bdef4e2d44da326644ca3
Query parameters
id = 8915c3253d0bdef4e2d44da326644ca3
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"removed" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=8915c3253d0bdef4e2d44da326644ca3&format=xml
Query parameters
id = 8915c3253d0bdef4e2d44da326644ca3
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<removed> 1 </removed>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=8915c3253d0bdef4e2d44da326644ca3&format=txt
Query parameters
id = 8915c3253d0bdef4e2d44da326644ca3
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_removed = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=8915c3253d0bdef4e2d44da326644ca3&format=plain
Query parameters
id = 8915c3253d0bdef4e2d44da326644ca3
format = plain
Response
1
Required parameters
parameter
description
idID
ID of the CTA from which to remove the webhook
Return values
parameter
description
removed
1 on success, 0 otherwise
/currencies /currencies/info
access: [READ]
This method returns a list of available currencies.
Example 1 (json)
Request
https://joturl.com/a/i1/currencies/info?id=1abbbaabad50f1a8d77de11e3af3d1b6
Query parameters
id = 1abbbaabad50f1a8d77de11e3af3d1b6
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : [
{
"id" : "1abbbaabad50f1a8d77de11e3af3d1b6" ,
"code" : "EUR" ,
"sign" : "€"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/currencies/info?id=1abbbaabad50f1a8d77de11e3af3d1b6&format=xml
Query parameters
id = 1abbbaabad50f1a8d77de11e3af3d1b6
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<i0>
<id> 1abbbaabad50f1a8d77de11e3af3d1b6 </id>
<code> EUR </code>
<sign> € </sign>
</i0>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/currencies/info?id=1abbbaabad50f1a8d77de11e3af3d1b6&format=txt
Query parameters
id = 1abbbaabad50f1a8d77de11e3af3d1b6
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_0_id = 1abbbaabad50f1a8d77de11e3af3d1b6
result_data_0_code = EUR
result_data_0_sign = €
Example 4 (plain)
Request
https://joturl.com/a/i1/currencies/info?id=1abbbaabad50f1a8d77de11e3af3d1b6&format=plain
Query parameters
id = 1abbbaabad50f1a8d77de11e3af3d1b6
format = plain
Response
1abbbaabad50f1a8d77de11e3af3d1b6
EUR
€
Required parameters
parameter
description
idID
ID of the currency
Return values
parameter
description
data
information on the specified currency
/currencies/list
access: [READ]
This method returns a list of available currencies.
Example 1 (json)
Request
https://joturl.com/a/i1/currencies/list
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"data" : [
{
"id" : "a9266bd59c50637c90450deb24b48edc" ,
"code" : "EUR" ,
"sign" : "€"
} ,
{
"id" : "64025b899db40dbdcbb0ce85535094ed" ,
"code" : "USD" ,
"sign" : "$"
} ,
{
"id" : "f39d1e6872eb93f3d8f0486a38b780b5" ,
"code" : "GBP" ,
"sign" : "£"
}
]
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/currencies/list?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<data>
<i0>
<id> a9266bd59c50637c90450deb24b48edc </id>
<code> EUR </code>
<sign> € </sign>
</i0>
<i1>
<id> 64025b899db40dbdcbb0ce85535094ed </id>
<code> USD </code>
<sign> $ </sign>
</i1>
<i2>
<id> f39d1e6872eb93f3d8f0486a38b780b5 </id>
<code> GBP </code>
<sign> £ </sign>
</i2>
</data>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/currencies/list?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_data_0_id = a9266bd59c50637c90450deb24b48edc
result_data_0_code = EUR
result_data_0_sign = €
result_data_1_id = 64025b899db40dbdcbb0ce85535094ed
result_data_1_code = USD
result_data_1_sign = $
result_data_2_id = f39d1e6872eb93f3d8f0486a38b780b5
result_data_2_code = GBP
result_data_2_sign = £
Example 4 (plain)
Request
https://joturl.com/a/i1/currencies/list?format=plain
Query parameters
format = plain
Response
a9266bd59c50637c90450deb24b48edc
EUR
€
64025b899db40dbdcbb0ce85535094ed
USD
$
f39d1e6872eb93f3d8f0486a38b780b5
GBP
£
Return values
parameter
description
data
information on the specified currency
/domains /domains/add
access: [WRITE]
Add a domain for the logged user.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data
Query parameters
id = 1234567890abcdef
force_https = 0
host = domain.ext
nickname = my domain nickname
redirect_url = https://redirect.users.to/
favicon_url = https://path.to/fav/icon
deeplink_id =
domain_domains_deeplink_name =
input = name_of_the_form_field_that_contains_image_data
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"id" : "1234567890abcdef" ,
"force_https" : "0" ,
"host" : "domain.ext" ,
"nickname" : "my domain nickname" ,
"redirect_url" : "https:\/\/redirect.users.to\/" ,
"favicon_url" : "https:\/\/path.to\/fav\/icon" ,
"logo" : "data:image\/gif;base64,R0lGODlhAQABAIAAAAAAAP\/\/\/yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" ,
"deeplink_id" : "" ,
"domain_domains_deeplink_name" : ""
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=xml
Query parameters
id = 1234567890abcdef
force_https = 0
host = domain.ext
nickname = my domain nickname
redirect_url = https://redirect.users.to/
favicon_url = https://path.to/fav/icon
deeplink_id =
domain_domains_deeplink_name =
input = name_of_the_form_field_that_contains_image_data
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<id> 1234567890abcdef </id>
<force_https> 0 </force_https>
<host> domain.ext </host>
<nickname> my domain nickname </nickname>
<redirect_url> https://redirect.users.to/ </redirect_url>
<favicon_url> https://path.to/fav/icon </favicon_url>
<logo> data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7 </logo>
<deeplink_id> </deeplink_id>
<domain_domains_deeplink_name> </domain_domains_deeplink_name>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=txt
Query parameters
id = 1234567890abcdef
force_https = 0
host = domain.ext
nickname = my domain nickname
redirect_url = https://redirect.users.to/
favicon_url = https://path.to/fav/icon
deeplink_id =
domain_domains_deeplink_name =
input = name_of_the_form_field_that_contains_image_data
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_id = 1234567890abcdef
result_force_https = 0
result_host = domain.ext
result_nickname = my domain nickname
result_redirect_url = https://redirect.users.to/
result_favicon_url = https://path.to/fav/icon
result_logo = data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7
result_deeplink_id =
result_domain_domains_deeplink_name =
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=plain
Query parameters
id = 1234567890abcdef
force_https = 0
host = domain.ext
nickname = my domain nickname
redirect_url = https://redirect.users.to/
favicon_url = https://path.to/fav/icon
deeplink_id =
domain_domains_deeplink_name =
input = name_of_the_form_field_that_contains_image_data
format = plain
Response
1234567890abcdef
0
domain.ext
my domain nickname
https://redirect.users.to/
https://path.to/fav/icon
data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7
Required parameters
parameter
description
max length
hostSTRING
domain to add (e.g., domain.ext)
850
Optional parameters
parameter
description
max length
deeplink_idID
ID of the deep link configuration
favicon_urlSTRING
the default favicon URL for the branded domain (to avoid securiy issues it must be HTTPS)
4000
forceBOOLEAN
1 to disable security checks, 0 otherwise. This parameter is ignored if force_https = 1
force_httpsBOOLEAN
1 to force HTTPS on HTTP requests, 0 otherwise (this flag takes effect only if a valid SSL certificate is associated with the domain)
inputSTRING
name of the HTML form field that contains image data for the logo (max dimensions 120px x 50px
, max size 150kB
), see notes for details
255
nicknameSTRING
the domain nickname
50
redirect_urlSTRING
the default destination URL where to redirect when a user types the domain without any alias (or an invalid alias)
4000
robots_txtSTRING
the robots.txt
content to serve for the domain, when robots_txt = :NONE:
requests to robots.txt
will return a 404 error, if empty the following robots.txt
will be served:user-agent: * disallow: /
4000
NOTES : The parameter input contains the name of the field of the HTML form that is used to send logo data to this method. Form must have enctype = "multipart/form-data"
and method = "post"
.
<form
action= "/a/i1/domains/add"
method= "post"
enctype= "multipart/form-data" >
<input name= "input" value= "logo" type= "hidden" />
[other form fields]
<input name= "logo" type= "file" />
</form>
Return values
parameter
description
deeplink_id
ID of the deep link configuration
deeplink_name
NA
favicon_url
default favicon URL
force_https
1 if the HTTPS is forced for the domain, 0 otherwise (this flag takes effect only if a valid SSL certificate is associated with the domain)
host
the domain that was just added
id
ID of the added domain
logo
default logo for the domain (base64 encoded)
nickname
the domain nickname
redirect_url
default redirect URL
robots_txt
the robots.txt
content to serve for the domain
/domains/certificates /domains/certificates/acmes /domains/certificates/acmes/domains/cert
access: [WRITE]
This method creates or renews an SSL certificate for a domain.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=b2aa1c9e31b2446231313999d25da397
Query parameters
domain_id = b2aa1c9e31b2446231313999d25da397
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"created" : 1 ,
"private_key" : "-----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY-----" ,
"csr" : "-----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST-----" ,
"cert" : "-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----" ,
"cert_fingerprint" : "9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264" ,
"cert_valid_from" : "2025-01-19T18:31:31" ,
"cert_valid_to" : "2025-04-19T18:31:31" ,
"intermediate" : "-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=b2aa1c9e31b2446231313999d25da397&format=xml
Query parameters
domain_id = b2aa1c9e31b2446231313999d25da397
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<created> 1 </created>
<private_key> -----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY----- </private_key>
<csr> -----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST----- </csr>
<cert> -----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE----- </cert>
<cert_fingerprint> 9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264 </cert_fingerprint>
<cert_valid_from> 2025-01-19T18:31:31 </cert_valid_from>
<cert_valid_to> 2025-04-19T18:31:31 </cert_valid_to>
<intermediate> -----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE----- </intermediate>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=b2aa1c9e31b2446231313999d25da397&format=txt
Query parameters
domain_id = b2aa1c9e31b2446231313999d25da397
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_created = 1
result_private_key = -----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY-----
result_csr = -----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST-----
result_cert = -----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----
result_cert_fingerprint = 9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264
result_cert_valid_from = 2025-01-19T18:31:31
result_cert_valid_to = 2025-04-19T18:31:31
result_intermediate = -----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=b2aa1c9e31b2446231313999d25da397&format=plain
Query parameters
domain_id = b2aa1c9e31b2446231313999d25da397
format = plain
Response
1
-----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY-----
-----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST-----
-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----
9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264
2025-01-19T18:31:31
2025-04-19T18:31:31
-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----
Required parameters
parameter
description
domain_idID
ID of the domain for which the SSL certificate is asked
Return values
parameter
description
cert
domain SSL certificate (PEM format)
cert_fingerprint
fingerprint of the SSL certificate
cert_valid_from
SSL certificate is valid from this date
cert_valid_to
SSL certificate is valid up to this date, usually the certificate expires 90 days after the cert_valid_from date; see <a href="https://letsencrypt.org/docs/faq/">the Let's Encrypt FAQ</a> for details
created
1 on success, 0 otherwise
csr
certificate signing request (CSR) for the doamin (PEM format)
intermediate
domain intermediate certificate(s) (PEM format)
private_key
domain private key (PEM format)
/domains/certificates/acmes/domains/install
access: [WRITE]
This method installs an SSL certificate for a domain.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=e7684cafce9129e02ab88450817a60d9
Query parameters
domain_id = e7684cafce9129e02ab88450817a60d9
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"installed" : 1 ,
"host" : "jo.my" ,
"cn" : "jo.my" ,
"certificate_domain_id" : "6e666877484257716e798888484252472b645a4a49518d8d" ,
"domains" : "jo.my, www.jo.my" ,
"fingerprint" : "6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265" ,
"id" : "69785a4b2f7676744c5a4759642f67524561584b58778d8d" ,
"valid_from" : "2018-01-23 14:58:37" ,
"valid_to" : "2018-04-23 14:58:37" ,
"issuer" : "JotUrl S.r.l."
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=e7684cafce9129e02ab88450817a60d9&format=xml
Query parameters
domain_id = e7684cafce9129e02ab88450817a60d9
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<installed> 1 </installed>
<host> jo.my </host>
<cn> jo.my </cn>
<certificate_domain_id> 6e666877484257716e798888484252472b645a4a49518d8d </certificate_domain_id>
<domains> jo.my, www.jo.my </domains>
<fingerprint> 6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265 </fingerprint>
<id> 69785a4b2f7676744c5a4759642f67524561584b58778d8d </id>
<valid_from> 2018-01-23 14:58:37 </valid_from>
<valid_to> 2018-04-23 14:58:37 </valid_to>
<issuer> JotUrl S.r.l. </issuer>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=e7684cafce9129e02ab88450817a60d9&format=txt
Query parameters
domain_id = e7684cafce9129e02ab88450817a60d9
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_installed = 1
result_host = jo.my
result_cn = jo.my
result_certificate_domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
result_domains = jo.my, www.jo.my
result_fingerprint = 6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
result_id = 69785a4b2f7676744c5a4759642f67524561584b58778d8d
result_valid_from = 2018-01-23 14:58:37
result_valid_to = 2018-04-23 14:58:37
result_issuer = JotUrl S.r.l.
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=e7684cafce9129e02ab88450817a60d9&format=plain
Query parameters
domain_id = e7684cafce9129e02ab88450817a60d9
format = plain
Response
1
jo.my
jo.my
6e666877484257716e798888484252472b645a4a49518d8d
jo.my, www.jo.my
6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
69785a4b2f7676744c5a4759642f67524561584b58778d8d
2018-01-23 14:58:37
2018-04-23 14:58:37
JotUrl S.r.l.
Required parameters
parameter
description
domain_idID
ID of the domain for which the SSL certificate has to be installed
Return values
parameter
description
certificate_domain_id
ID of the domain the certificate belongs to
cn
common name of the certificate
domains
comma separated list of domains covered by the certificate (e.g., "domain.ext, www.domain.ext")
fingerprint
fingerprint of the certificate
host
domain the certificate belongs to
id
ID of the certificate
installed
1 on success, 0 otherwise
issuer
the certificate issuer
valid_from
the certificate is valid from this dat, can be in the future (e.g., 2018-05-30 13:38:04)
valid_to
the certificate is valid up to this date, can be in the past (e.g., 2020-05-29 13:38:04)
/domains/certificates/acmes/domains/revoke
access: [WRITE]
This method revokes an SSL certificate for a domain.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=edc71c457da72edc9af0817918d8170b
Query parameters
domain_id = edc71c457da72edc9af0817918d8170b
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"revoked" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=edc71c457da72edc9af0817918d8170b&format=xml
Query parameters
domain_id = edc71c457da72edc9af0817918d8170b
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<revoked> 1 </revoked>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=edc71c457da72edc9af0817918d8170b&format=txt
Query parameters
domain_id = edc71c457da72edc9af0817918d8170b
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_revoked = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=edc71c457da72edc9af0817918d8170b&format=plain
Query parameters
domain_id = edc71c457da72edc9af0817918d8170b
format = plain
Response
1
Required parameters
parameter
description
domain_idID
ID of the domain for which the SSL certificate should be revoked
Return values
parameter
description
revoked
1 on success, 0 otherwise
/domains/certificates/acmes/domains/validate
access: [WRITE]
This method validates a domain. You have to validate a domain before creating an SSL certificate.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=7172e3448e95e9e15ec4ccaaaafafdde
Query parameters
domain_id = 7172e3448e95e9e15ec4ccaaaafafdde
Response
{
"status" : "pending"
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=7172e3448e95e9e15ec4ccaaaafafdde&format=xml
Query parameters
domain_id = 7172e3448e95e9e15ec4ccaaaafafdde
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status> pending </status>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=7172e3448e95e9e15ec4ccaaaafafdde&format=txt
Query parameters
domain_id = 7172e3448e95e9e15ec4ccaaaafafdde
format = txt
Response
status = pending
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=7172e3448e95e9e15ec4ccaaaafafdde&format=plain
Query parameters
domain_id = 7172e3448e95e9e15ec4ccaaaafafdde
format = plain
Response
pending
Required parameters
parameter
description
domain_idID
ID of the domain to validate
Optional parameters
parameter
description
include_www_subdomainBOOLEAN
1 if the WWW subdomain should be asked, 0 otherwise
Return values
parameter
description
domains
list of available domains in the certificate
status
status of the validation request; call this method until a valid status is returned or a timeout of 30 seconds occurs. If the validation fails, you have to wait at least 30 minutes before retrying [unknown|pending|valid]
/domains/certificates/acmes/users/deactivate
access: [WRITE]
This method deactivates a user on the Let's Encrypt ACME server.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"deactivated" : 0
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<deactivated> 0 </deactivated>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_deactivated = 0
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate?format=plain
Query parameters
format = plain
Response
0
Return values
parameter
description
deactivated
1 on success, 0 otherwise
/domains/certificates/acmes/users/generatekey
access: [WRITE]
This method generates an RSA key for the user, this key have to be used with all operations on the Let's Encrypt ACME server.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"generated" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<generated> 1 </generated>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_generated = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey?format=plain
Query parameters
format = plain
Response
1
Return values
parameter
description
generated
1 on success, 0 otherwise
/domains/certificates/acmes/users/register
access: [WRITE]
This method registers a user on the Let's Encrypt ACME server.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/register
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"registered" : 1
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/register?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<registered> 1 </registered>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/register?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_registered = 1
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/acmes/users/register?format=plain
Query parameters
format = plain
Response
1
Optional parameters
parameter
description
agreementSTRING
links to the Let's Encrypt agreement. Registration on Let's Encrypt ACME server requires two steps; in the first one you have to call this method without parameters, it will return an agreement link and the security parameter nonce, that the user must explicitely approve the agreement; in the second step, you have to call this method with parameters agreement and nonce set to the values returned by the previous call
forceBOOLEAN
1 if the registration process have to be forced (overwriting old values), 0 otherwise
nonceID
a random security string to be used during the registration process
Return values
parameter
description
agreement
[OPTIONAL] returned only if agreement is needed (agreement is only in English)
nonce
[OPTIONAL] returned only if agreement is needed
registered
1 on success, 0 otherwise
/domains/certificates/add
access: [WRITE]
This method allows to upload a certificate for a specific domain.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D
Query parameters
domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
cert_files_type = pfx
input_pfx_archive = [pfx_file]
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"host" : "jo.my" ,
"id" : "69785a4b2f7676744c5a4759642f67524561584b58778d8d" ,
"fingerprint" : "6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265" ,
"valid_from" : "2018-01-23 14:58:37" ,
"valid_to" : "2018-04-23 14:58:37" ,
"cn" : "jo.my" ,
"domains" : "jo.my, www.jo.my"
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D&format=xml
Query parameters
domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
cert_files_type = pfx
input_pfx_archive = [pfx_file]
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<host> jo.my </host>
<id> 69785a4b2f7676744c5a4759642f67524561584b58778d8d </id>
<fingerprint> 6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265 </fingerprint>
<valid_from> 2018-01-23 14:58:37 </valid_from>
<valid_to> 2018-04-23 14:58:37 </valid_to>
<cn> jo.my </cn>
<domains> jo.my, www.jo.my </domains>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D&format=txt
Query parameters
domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
cert_files_type = pfx
input_pfx_archive = [pfx_file]
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_host = jo.my
result_id = 69785a4b2f7676744c5a4759642f67524561584b58778d8d
result_fingerprint = 6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
result_valid_from = 2018-01-23 14:58:37
result_valid_to = 2018-04-23 14:58:37
result_cn = jo.my
result_domains = jo.my, www.jo.my
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D&format=plain
Query parameters
domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
cert_files_type = pfx
input_pfx_archive = [pfx_file]
format = plain
Response
jo.my
69785a4b2f7676744c5a4759642f67524561584b58778d8d
6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
2018-01-23 14:58:37
2018-04-23 14:58:37
jo.my
jo.my, www.jo.my
Required parameters
parameter
description
cert_files_typeSTRING
this parameter must be pfx
or cert_files
, according to the certificate files
domain_idID
ID of the domain the certificate belongs to
Optional parameters
parameter
description
input_ca_certificate1STRING
name of the HTML form field that is used to transfer the ca certificate #1 data, see notes for details
input_ca_certificate2STRING
name of the HTML form field that is used to transfer the ca certificate #2 data, see notes for details
input_ca_certificate3STRING
name of the HTML form field that is used to transfer the ca certificate #2 data, see notes for details
input_certificateSTRING
name of the HTML form field that is used to transfer the certificate data, mandatory if cert_files_type = cert_files
, see notes for details
input_pfx_archiveSTRING
name of the HTML form field that is used to transfer the PFX data, mandatory if cert_files_type = pfx
, see notes for details
input_private_keySTRING
name of the HTML form field that is used to transfer the private key data, mandatory if cert_files_type = cert_files
, see notes for details
pfx_passwordHTML
password of the PFX archive, mandatory if cert_files_type = pfx
and the PFX archive is protected by a password
NOTES : Parameters starting with input_ are the names of the field of the HTML form used to send data to this method. Form must have enctype = "multipart/form-data"
and method = "post"
.
<form
action= "/a/i1/domains/certificates/add"
method= "post"
enctype= "multipart/form-data" >
<input name= "input_pfx_archive" value= "pfx_file" type= "hidden" />
<input name= "input_private_key" value= "private_key_file" type= "hidden" />
<input name= "input_certificate" value= "certificate_file" type= "hidden" />
<input name= "input_ca_certificate1" value= "certificate1_file" type= "hidden" />
<input name= "input_ca_certificate2" value= "certificate2_file" type= "hidden" />
<input name= "input_ca_certificate3" value= "certificate3_file" type= "hidden" />
[other form fields]
<input name= "pfx_file" type= "file" />
<input name= "private_key_file" type= "file" />
<input name= "certificate_file" type= "file" />
<input name= "certificate1_file" type= "file" />
<input name= "certificate2_file" type= "file" />
<input name= "certificate3_file" type= "file" />
</form>
Return values
parameter
description
cn
common name of the certificate
domain_id
ID of the domain the certificate belongs to
domains
comma separated list of domains covered by the certificate (e.g., "domain.ext, www.domain.ext")
fingerprint
fingerprint of the certificate
host
domain the certificate belongs to
id
ID of the certificate
valid_from
the certificate is valid from this dat, can be in the future (e.g., 2018-05-30 13:38:04)
valid_to
the certificate is valid up to this date, can be in the past (e.g., 2020-05-29 13:38:04)
/domains/certificates/count
access: [READ]
This method returns number of certificates associated to a specific domain.
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/count
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"count" : 3
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/count?format=xml
Query parameters
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<count> 3 </count>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/count?format=txt
Query parameters
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_count = 3
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/count?format=plain
Query parameters
format = plain
Response
3
Optional parameters
parameter
description
domain_idID
filters certificates for this domain ID
searchSTRING
count items by searching them
Return values
parameter
description
count
number of (filtered) certificates
/domains/certificates/csr /domains/certificates/csr/create
access: [WRITE]
This method allows to create a Certificate Signing Request (CSR).
Example 1 (json)
Request
https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US
Query parameters
commonName = domain.ext
organizationName = My Company
organizationalUnitName = accounting
localityName = Los Angeles
stateOrProvinceName = California
countryName = US
Response
{
"status" : {
"code" : 200 ,
"text" : "OK" ,
"error" : "" ,
"rate" : 0
} ,
"result" : {
"private_key" : "-----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq 0\/vm\/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMml HMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rh nZNOCM2+NeKvZxN0ZUXTRn2Ed\/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykE PP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC\/TyDZT2J8Q+w5SEMVylehHNd\/8b5 l3f7NhIW50eIZsmY0xgfpV1wsHUp\/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEV TqdTl05\/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh\/hD xyg0pFqTY4Vq48co5q9pG0wWEt\/cN\/73jbnSpIIjgjo+gU8M7UWYzlUk\/9uRVbLC 7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzX ZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGL AGjkfMdErAHGK2k\/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZ sGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOm YPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q 4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3y tbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F\/wlkZk2aNHKATu1GZhYKhpGUbhC vPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVF K6hpQu7x8hZ1yuehpW3azhm98\/eV7bW48SMcvHl6CGEffGnpQrJ\/ou52mYMhS3Ga UglUmQGybHkCgYEAm5OsL1P\/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT 9ZZuwbDDfgYBr\/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9Hkf kteB03tGGZAA7qHy\/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+\/pI9hiCYvcCgYBf 9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM\/eBk\/72FwF+X9OtxWo8J4f6h2 yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53 Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga\/hpw qGoJ8bl5gab0U\/1u9sXdbMKqeyyaFjXo\/RaLdSOG9y4UFJP\/2JMeTh1FRCWaN7rK 6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc\/zK1OZfUZmOLV+3 yZDE4U3\/Zkgx7gSM\/Ffxw\/62 -----END PRIVATE KEY----- " ,
"csr" : "-----BEGIN CERTIFICATE REQUEST----- MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx FDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYD VQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG 9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2\/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3IS EzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h\/NkAgoe y8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9 hHfwk+rRg1LgrFyAaEcM\/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0\/ZGN1 rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf\/G+Zd3+zYSFudHiGbJmNMYH6Vd cLB1Kf6Eb8jYEaIPgegp5kbgG\/es5l3\/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJ KoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5\/Qa+kCFzsVDpEaJOuc 2GujOYydNTwFpsQCcVdW\/LR1mbsiS2CVTMTP+VrppiC\/XIJ0btlXeRNzLZdQ9UaX xBgj46J79oYxXkIpnskcms3SsrKGnK\/Q1bnus0jpvTlji9DnZglQt9QvzePF15As QCERgitEUTRKzxvYjozq\/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7 XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9 S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s= -----END CERTIFICATE REQUEST----- "
}
}
Example 2 (xml)
Request
https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US&format=xml
Query parameters
commonName = domain.ext
organizationName = My Company
organizationalUnitName = accounting
localityName = Los Angeles
stateOrProvinceName = California
countryName = US
format = xml
Response
<?xml version ="1.0" encoding ="UTF-8" ?>
<response>
<status>
<code> 200 </code>
<text> OK </text>
<error> </error>
<rate> 0 </rate>
</status>
<result>
<private_key> -----BEGIN PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq
0/vm/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMml
HMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rh
nZNOCM2+NeKvZxN0ZUXTRn2Ed/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykE
PP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC/TyDZT2J8Q+w5SEMVylehHNd/8b5
l3f7NhIW50eIZsmY0xgfpV1wsHUp/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEV
TqdTl05/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh/hD
xyg0pFqTY4Vq48co5q9pG0wWEt/cN/73jbnSpIIjgjo+gU8M7UWYzlUk/9uRVbLC
7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzX
ZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGL
AGjkfMdErAHGK2k/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZ
sGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOm
YPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q
4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3y
tbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F/wlkZk2aNHKATu1GZhYKhpGUbhC
vPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVF
K6hpQu7x8hZ1yuehpW3azhm98/eV7bW48SMcvHl6CGEffGnpQrJ/ou52mYMhS3Ga
UglUmQGybHkCgYEAm5OsL1P/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT
9ZZuwbDDfgYBr/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9Hkf
kteB03tGGZAA7qHy/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+/pI9hiCYvcCgYBf
9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM/eBk/72FwF+X9OtxWo8J4f6h2
yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53
Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga/hpw
qGoJ8bl5gab0U/1u9sXdbMKqeyyaFjXo/RaLdSOG9y4UFJP/2JMeTh1FRCWaN7rK
6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc/zK1OZfUZmOLV+3
yZDE4U3/Zkgx7gSM/Ffxw/62
-----END PRIVATE KEY-----
</private_key>
<csr> -----BEGIN CERTIFICATE REQUEST-----
MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
FDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYD
VQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG
9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3IS
EzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h/NkAgoe
y8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9
hHfwk+rRg1LgrFyAaEcM/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0/ZGN1
rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf/G+Zd3+zYSFudHiGbJmNMYH6Vd
cLB1Kf6Eb8jYEaIPgegp5kbgG/es5l3/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJ
KoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5/Qa+kCFzsVDpEaJOuc
2GujOYydNTwFpsQCcVdW/LR1mbsiS2CVTMTP+VrppiC/XIJ0btlXeRNzLZdQ9UaX
xBgj46J79oYxXkIpnskcms3SsrKGnK/Q1bnus0jpvTlji9DnZglQt9QvzePF15As
QCERgitEUTRKzxvYjozq/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7
XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9
S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s=
-----END CERTIFICATE REQUEST-----
</csr>
</result>
</response>
Example 3 (txt)
Request
https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US&format=txt
Query parameters
commonName = domain.ext
organizationName = My Company
organizationalUnitName = accounting
localityName = Los Angeles
stateOrProvinceName = California
countryName = US
format = txt
Response
status_code = 200
status_text = OK
status_error =
status_rate = 0
result_private_key = -----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq0/vm/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMmlHMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rhnZNOCM2+NeKvZxN0ZUXTRn2Ed/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykEPP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC/TyDZT2J8Q+w5SEMVylehHNd/8b5l3f7NhIW50eIZsmY0xgfpV1wsHUp/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEVTqdTl05/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh/hDxyg0pFqTY4Vq48co5q9pG0wWEt/cN/73jbnSpIIjgjo+gU8M7UWYzlUk/9uRVbLC7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzXZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGLAGjkfMdErAHGK2k/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZsGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOmYPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3ytbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F/wlkZk2aNHKATu1GZhYKhpGUbhCvPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVFK6hpQu7x8hZ1yuehpW3azhm98/eV7bW48SMcvHl6CGEffGnpQrJ/ou52mYMhS3GaUglUmQGybHkCgYEAm5OsL1P/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT9ZZuwbDDfgYBr/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9HkfkteB03tGGZAA7qHy/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+/pI9hiCYvcCgYBf9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM/eBk/72FwF+X9OtxWo8J4f6h2yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga/hpwqGoJ8bl5gab0U/1u9sXdbMKqeyyaFjXo/RaLdSOG9y4UFJP/2JMeTh1FRCWaN7rK6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc/zK1OZfUZmOLV+3yZDE4U3/Zkgx7gSM/Ffxw/62-----END PRIVATE KEY-----
result_csr = -----BEGIN CERTIFICATE REQUEST-----MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYDVQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3ISEzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h/NkAgoey8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9hHfwk+rRg1LgrFyAaEcM/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0/ZGN1rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf/G+Zd3+zYSFudHiGbJmNMYH6VdcLB1Kf6Eb8jYEaIPgegp5kbgG/es5l3/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5/Qa+kCFzsVDpEaJOuc2GujOYydNTwFpsQCcVdW/LR1mbsiS2CVTMTP+VrppiC/XIJ0btlXeRNzLZdQ9UaXxBgj46J79oYxXkIpnskcms3SsrKGnK/Q1bnus0jpvTlji9DnZglQt9QvzePF15AsQCERgitEUTRKzxvYjozq/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s=-----END CERTIFICATE REQUEST-----
Example 4 (plain)
Request
https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US&format=plain
Query parameters
commonName = domain.ext
organizationName = My Company
organizationalUnitName = accounting
localityName = Los Angeles
stateOrProvinceName = California
countryName = US
format = plain
Response
-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq0/vm/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMmlHMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rhnZNOCM2+NeKvZxN0ZUXTRn2Ed/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykEPP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC/TyDZT2J8Q+w5SEMVylehHNd/8b5l3f7NhIW50eIZsmY0xgfpV1wsHUp/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEVTqdTl05/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh/hDxyg0pFqTY4Vq48co5q9pG0wWEt/cN/73jbnSpIIjgjo+gU8M7UWYzlUk/9uRVbLC7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzXZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGLAGjkfMdErAHGK2k/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZsGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOmYPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3ytbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F/wlkZk2aNHKATu1GZhYKhpGUbhCvPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVFK6hpQu7x8hZ1yuehpW3azhm98/eV7bW48SMcvHl6CGEffGnpQrJ/ou52mYMhS3GaUglUmQGybHkCgYEAm5OsL1P/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT9ZZuwbDDfgYBr/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9HkfkteB03tGGZAA7qHy/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+/pI9hiCYvcCgYBf9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM/eBk/72FwF+X9OtxWo8J4f6h2yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga/hpwqGoJ8bl5gab0U/1u9sXdbMKqeyyaFjXo/RaLdSOG9y4UFJP/2JMeTh1FRCWaN7rK6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc/zK1OZfUZmOLV+3yZDE4U3/Zkgx7gSM/Ffxw/62-----END PRIVATE KEY-----
-----BEGIN CERTIFICATE REQUEST-----MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYDVQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3ISEzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h/NkAgoey8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9hHfwk+rRg1LgrFyAaEcM/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0/ZGN1rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf/G+Zd3+zYSFudHiGbJmNMYH6VdcLB1Kf6Eb8jYEaIPgegp5kbgG/es5l3/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5/Qa+kCFzsVDpEaJOuc2GujOYydNTwFpsQCcVdW/LR1mbsiS2CVTMTP+VrppiC/XIJ0btlXeRNzLZdQ9UaXxBgj46J79oYxXkIpnskcms3SsrKGnK/Q1bnus0jpvTlji9DnZglQt9QvzePF15AsQCERgitEUTRKzxvYjozq/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s=-----END CERTIFICATE REQUEST-----
Required parameters
parameter
description
commonNameSTRING
the Fully Qualified Domain Name (FQDN) for which you are requesting the SSL Certificate, it must contain domain you are requesting a certifacate for (e.g., domain.ext, *.domain.ext)
countryNameSTRING
2-digit code of the country (ISO Alpha-2) the company is based on (e.g., US)
localityNameSTRING
the full name of the locality the company is based on (e.g., Los Angeles)
organizationNameSTRING
the full legal company or personal name, as legally registered, that is requesting the certificate (e.g., My Company)
organizationalUnitNameSTRING
whichever branch of the company is ordering the certificate (e.g., accounting, marketing)
stateOrProvinceNameSTRING
the full name of the state or province the company is based on (e.g., California)
Return values
parameter
description
csr
Certificate request (CSR)
private_key
Private key
/domains/certificates/delete
access: [WRITE]
This method deletes a certificate.