fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Configuration

9. Agregar IP

URL:

https://wv{{wolvox_server}}.wolkvox.com/api/v2/configuration.php?api=add_ip

Descripción:

Esta API permite ingresar una IP al firewall del servidor de una operación para que habilitarle el acceso a este.

Beneficio:

Añada de forma rápida las IP de sus usuarios o servidores a nuestro firewall para permitir ejecución de acciones.

Cómo funciona:

  • El consumo de esta API se realiza por método POST
  • En el json se agregan los parámetros de acuerdo a la operación o proceso a realizar.
  • Para consumir esta API debe reemplazar en la url {{wolkvox_server}} por la nomenclatura del servidor de la operación.
  • Se debe hacer uso del header wolkvox-token: {{token}} para hacer uso de el token de autorización.
  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.

REQUEST

REQUEST
NAME DESCRIPTION TYPE
ip Dirección IPv4 a adicionar en el módulo. String
permanent Define si la ip a ingresar es permanente o temporal. Este campo recibe el valor “yes” y “no”. Si no se envía un valor, por defecto será “no”. Hay un máximo de 5 IPs permanentes por operación. String
description Descripción del api adicionada. String

RESPONSE

RESPONSE
NAME DESCRIPTION TYPE
code Código de respuesta. int
error Error. String
msg Descripción de la respuesta. String

Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolvox_server}}.wolkvox.com/api/v2/configuration.php?api=add_ip',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "ip": "",
    "permanent": "",
   "description": ""
}
',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "201",
    "error": null,
    "msg": "IP: XXX.XXX.XXX.XXX has been added successfully"
}
				
			

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales