cURL php javascript

Introducción

La documentación de la API de NEUBOX ofrece una descripción de los métodos y endpoints disponibles, ejemplos de las posibles respuestas obtenidas e información general para facilitar el uso de nuestra API.

Información general

Esta API esta diseñada para obtener el listado de dominios, realizar compras, renovaciones o búsqueda de dominios con saldo a favor.

La documentación de la API de NEUBOX ofrece una descripción detallada de los métodos y endpoints (URLs o direcciones) disponibles con ejemplos de las posibles respuestas a obtener o enviar. Además podrás consultar información general que facilitará su uso.

Diseñada para clientes con un alto volumen de compras, la API de NEUBOX (Application Programming Interface), busca permitir al usuario interactuar con nuestro sistema de manera más eficiente.

Con la API de NEUBOX, podrás realizar peticiones para la administración de tus Dominios de forma personalizada y de acuerdo a tus necesidades.

Dominios

Listado de dominios

curl -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'neubox-api-key: TU_API_KEY' \
  -H 'neubox-api-secret: TU_API_SECRET' \
  -H 'User-Agent: Ejemplo/1.0' \
  -H 'neubox-user-email: '$(echo -n "[email protected]" | base64)'' \
  -d '{"email": "'$(echo -n "[email protected]" | base64)'"}' \
  https://api.neubox.com/getdomains


$url = "https://api.neubox.com/getdomains";
$headers = [
  'Accept: application/json',
  'Content-Type: application/json',
  'neubox-api-key: TU_API_KEY',
  'neubox-api-secret: TU_API_SECRET',
  'User-Agent: Ejemplo/1.0',
  'neubox-user-email: '.base64_encode('[email protected]'),
];
$postfields = array("email" => base64_encode('[email protected]')
                                          );
$postfields = json_encode($postfields);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($ch);
curl_close($ch);

const https = require('https');

const options = {
  method: 'POST',
  hostname: 'api.neubox.com',
  path: '/getdomains',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'neubox-api-key': 'TU_API_KEY',
    'neubox-api-secret': 'TU_API_SECRET',
    'User-Agent': 'Ejemplo/1.0',
    'neubox-user-email': Buffer.from('[email protected]').toString('base64')
  }
};

const req = https.request(options, (res) => {
  let response = '';

  res.on('data', (chunk) => {
    response += chunk;
  });

  res.on('end', () => {
    console.log(response);
  });
});

req.write(JSON.stringify({ email: Buffer.from('[email protected]').toString('base64') }));
req.end();

Ejemplo de respuesta:

{
  "result":"success",
  "response":[
    {
        "domain":"midominio.com",
        "registrationdate":"2019-04-21",
        "recurringamount":591.25,
        "expirydate":"2016-04-21",
        "status":"Active"
    },
    {
        "domain":"midominio2.com",
        "registrationdate":"2018-04-21",
        "recurringamount":591.25,
        "expirydate":"2016-04-21",
        "status":"Active"
    }
  ]
}

A continuación se explica como listar tus Dominios, con un ejemplo y muestra de posibles respuestas obtenidas.

Construcción de la URL

POST https://api.neubox.com/getdomains

Parámetros de solicitud

Parámetro Tipo Descripción Requerido
email string El email con el que está registrada la cuenta en NEUBOX (codificado en base64) Requerido

Compra de Dominios

curl -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'neubox-api-key: TU_API_KEY' \
  -H 'neubox-api-secret: TU_API_SECRET' \
  -H 'User-Agent: Ejemplo/1.0' \
  -H 'neubox-user-email: '$(echo -n "[email protected]" | base64)'' \
  -d '{"domains":["example.com","example2.com"],"regperiod":[1,2]}' \
  https://api.neubox.com/registerdomain

 $url = "https://api.neubox.com/registerdomain";
 $headers = [
  'Accept: application/json',
  'Content-Type: application/json',
  'neubox-api-key: TU_API_KEY',
  'neubox-api-secret: TU_API_SECRET',
  'User-Agent: Ejemplo/1.0',
  'neubox-user-email: '.base64_encode('[email protected]'),
];
$postfields = array(
  "domains" => array("example.com","example2.com"),
  "regperiod" => array(1,2)
);
$postfields = json_encode($postfields);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($ch);
curl_close($ch);

var headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json',
  'neubox-api-key': 'TU_API_KEY',
  'neubox-api-secret': 'TU_API_SECRET',
  'User-Agent': 'Ejemplo/1.0',
  'neubox-user-email': Buffer.from('[email protected]').toString('base64')
};

var postfields = JSON.stringify({
  "domains": ["example.com", "example2.com"],
  "regperiod": [1, 2]
});

fetch("https://api.neubox.com/registerdomain", {
  method: "POST",
  headers: headers,
  body: postfields
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

Ejemplo de respuesta:

{
  "result":"success",
  "response":{
    "result":"success",
    "invoiceid":22333,
    "amount":591.25,
    "invoicepaid":"true",
    "credit":"826.48",
    "example.com":"registered",
    "example2.com":"registered"
  }
}

A continuación se explica como comprar Dominios, con un ejemplo y muestra de posibles respuestas obtenidas.

Construcción de la URL

POST https://api.neubox.com/registerdomain

Parámetros de solicitud

Parámetro Tipo Descripción Requerido
domains array Los nombres de dominio a comprar.Ejemplo: ['dominio1.com', 'dominio2.com'] Requerido
regperiod array Los períodos de registro de los dominios a comprar. Ejemplo: [1,2] Requerido

Renovación de Dominios

curl -X POST \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'neubox-api-key: TU_API_KEY' \
  -H 'neubox-api-secret: TU_API_SECRET' \
  -H 'User-Agent: Ejemplo/1.0' \
  -H 'neubox-user-email: '$(echo -n "[email protected]" | base64)'' \
  -d '{"domains":["example.com","example2.com"],"renewperiod":[1,2]}' \
  https://api.neubox.com/renewdomain

 $url = "https://api.neubox.com/renewdomain";
 $headers = [
  'Accept: application/json',
  'Content-Type: application/json',
  'neubox-api-key: TU_API_KEY',
  'neubox-api-secret: TU_API_SECRET',
  'User-Agent: Ejemplo/1.0',
  'neubox-user-email: '.base64_encode('[email protected]'),
];
$postfields = array(
  "domains" => array("example.com","example2.com"),
  "renewperiod" => array(1,2)
);
$postfields = json_encode($postfields);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($ch);
curl_close($ch);

var headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json',
  'neubox-api-key': 'TU_API_KEY',
  'neubox-api-secret': 'TU_API_SECRET',
  'User-Agent': 'Ejemplo/1.0',
  'neubox-user-email': Buffer.from('[email protected]').toString('base64')
};

var postfields = JSON.stringify({
  "domains": ["example.com", "example2.com"],
  "renewperiod": [1, 2]
});

fetch("https://api.neubox.com/renewdomain", {
  method: "POST",
  headers: headers,
  body: postfields
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

Ejemplo de respuesta:

{
  "result":"success",
  "response":{
    "result":"success",
    "invoiceid":100231,
    "amount":462.88,
    "invoicepaid":"true",
    "credit":"882.00",
    "example.com.mx":"registered",
    "example.com":"registered"
  }
}

A continuación se explica como renovar Dominios, con un ejemplo y muestra de posibles respuestas obtenidas.

Construcción de la URL

POST https://api.neubox.com/renewdomain

Parámetros de solicitud

Parámetro Tipo Descripción Requerido
domains array Los nombres de dominio a renovar. Ejemplo: ['dominio1.com', 'dominio2.com'] Requerido
renewperiod array Los períodos de renovación de los dominios en el orden. Ejemplo: [1,2] Requerido

Búsqueda de Dominios

curl -X POST https://api.neubox.com/searchdomains \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "neubox-api-key: TU_API_KEY" \
  -H "neubox-api-secret: TU_API_SECRET" \
  -H "User-Agent: Ejemplo/1.0" \
  -H "neubox-user-email: $(echo -n '[email protected]' | base64)" \
  -d '{"domain":"midominio.com","tlds":["mx","net"]}'


 $url = "https://api.neubox.com/searchdomains";
 $headers = [
  'Accept: application/json',
  'Content-Type: application/json',
  'neubox-api-key: TU_API_KEY',
  'neubox-api-secret: TU_API_SECRET',
  'User-Agent: Ejemplo/1.0',
  'neubox-user-email: '.base64_encode('[email protected]'),
];
$postfields = array(
  "domain" => "midominio.com",
  "tlds" => array("mx","net")
);
$postfields = json_encode($postfields);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($ch);
curl_close($ch);

const headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json',
  'neubox-api-key': 'TU_API_KEY',
  'neubox-api-secret': 'TU_API_SECRET',
  'User-Agent': 'Ejemplo/1.0',
  'neubox-user-email': btoa('[email protected]'),
};

const postData = {
  "domain": "midominio.com",
  "tlds": ["mx", "net"]
};

fetch('https://api.neubox.com/searchdomains', {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(postData)
})
.then(res => res.json())
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

Ejemplo de respuesta:

{
  "result":"success",
  "response":{
    "search":"midominio.com",
    "sld":"midominio",
    "tld":"com",
    "available":[
        "net",
        "mx",
        "com"
    ],
    "unavailable":[
        "mx"
    ]
  }
}

A continuación se explica como consultar Dominios disponibles, con un ejemplo y muestra de posibles respuestas obtenidas.

Construcción de la URL

POST https://api.neubox.com/searchdomains

Parámetros de solicitud

Parámetro Tipo Descripción Requerido
domain string El nombre de dominio a buscar. Ejemplo: midominio.com Requerido
tlds array Los TLDs a buscar. Ejemplo: ['mx','net'] Requerido

Errores

Listado de dominios

POST https://api.neubox.com/getdomains

Ejemplo de error:

{
   "result":"success",
   "error":"Bad Request",
   "response":"User doesnt exists"
 }

Compra de dominios

POST https://api.neubox.com/registerdomain

Ejemplo de error:

{
  "result": "success",
  "response": {
    "result": "error",
    "message": "Crédito insuficiente, el recibo se genero          correctamente, podras pagarlo en tu panel de administración, Sí esta información   es incorrecta pongase en contacto en [email protected]",
    "credit": "$150.96",
    "invoiceid": 102013,
    "invoicepaid": "unpaid",
    "unvailabledomains": {
      "1": "neubox.com",
      "2": "neubox.mx"
    }
  }
}

Renovación de dominios

POST https://api.neubox.com/renewdomain

Ejemplo de error:

{
   "result":"success",
   "response":{
      "message":"Crédito insuficiente, el recibo se genero correctamente, podras     pagarlo en tu panel de administración, Sí esta información es incorrecta pongase en contacto en [email protected]",
      "credit":"0.0",
      "invoiceid":24312,
      "invoicepaid":false,
      "example.com.mx":"available",
      "example.com":"available"
   }
}

Búsqueda de dominios

POST https://api.neubox.com/searchdomains

Ejemplo de error:

{
   "result":"error",
   "error":"Only 10 requests per minute are allowed"
}
cURL php javascript