ESTRATEGIAS WEBSITE S.L. Manual de instrucciones API versión 4.2

(1)

ESTRATEGIAS WEBSITE S.L.

Manual de instrucciones API versión 4.2

(2)

1. Introducción

La versión 4 del api supone un amplio número de mejoras y ampliaciones sobre el anterior existente.

Principalmente viene a resolver una petición por parte de los clientes que solicitaban que el api no funcionara en base a formularios si no que les permitiera recoger y tratar las solicitudes por medio de código y en base a sus propias herramientas. Por otro lado recoge los dominios internacionales y permite hacer modificaciones de dominios por api.

La nueva versión 4.2 que empieza a funcionar desde el 27/10/2008 incluye las extensiones:

.es .com .net .org .info .biz .name .mobi

Para los dominios .es, .com.,es, nom.es, .eu que ya disponían de api seguirá funcionando la versión

3.00 del api entre 30 y 45 días para permitir a los usuarios de este adaptarse a la nueva versión.

(3)

2. Comandos

Las llamadas se realizarán a una única url:

- Plataforma demo: http://api.extranetdeclientes.com/apidemo/api.php - Plataforma producción: http://api.extranetdeclientes.com/api/api.php

Todos los comandos, necesitan como mínimo el parámetro apikey y el comando especifico de la acción.

Para demo el apikey es siempre: vname001 para utilizarlo en producción debe solicitarnos su apikey.

La forma de enviar los datos es por POST , por lo que será sencillo implementar una solución basada en CURL .

El sistema responde siempre con un XML.

Hay un campo llamado estado que solo podrá tener 2 valores, true o false , si es true el comando a sido ejecutado de forma correcta y si es false, devuelve el error que ha ocurrido.

Ejemplo de POST con PHP y CURL:

<?php

$ch = curl_init('http://www.extranetdeclientes.com/apidemo/api.php');

curl_setopt ($ch, CURLOPT_POST, 1);

curl_setopt ($ch, CURLOPT_POSTFIELDS, "apikey=valor1&dominio=valor2&tld=valor3");

curl_exec ($ch);

curl_close ($ch);

?>

Nota: Todos los ejemplos que se presentan a continuación así como la versión DEMO del api están con GET, tan solo para poder realizar pruebas más rápidamente, la versión en PRODUCCIÓN sin embargo funciona por post.

* Listado de comandos disponibles:

Comando Utilidad

check Comprueba si un dominio está disponible

domcontacts Muestra los id de contacto de un dominio viewcontact Muestra los datos de un id de contacto

domdns Muestra las dns de un dominio

renewdomain Renovación de dominio

addcontact Crea un nuevo contacto y nos da el id

registerdomain Registra un dominio en base a su nombre, id´s de contacto y dns transferdomain Solicita la transferencia de un dominio

modifydns Modifica las dns de un dominio

viewdomaininfo Muestra la fecha de registro y vencimiento del dominio

modifycontact Modifica los datos de un id de contacto (NO DISPONIBLE .ES) viewsecret Muestra el auth code de un dominio (NO DISPONIBLE .ES) modifydomaincontacts Modifica los contactos de un dominio (sustituye un id por otro)

(4)

3. Comprobar disponibilidad del dominio Comando: check

- Parámetros necesarios:

Apikey dominio tld

- Ejemplo del código para realizar la consulta:

<form id="form1" name="form1" method="get"

action="http://api.extranetdeclientes.com/apidemo/api.php">

Apikey

<br />

</form>

- Ejemplo de respuesta:

<command>check</command>

<text>The domain virtualname.com is available</text>

</response>

(5)

4. Ver datos de contacto de un dominio

Muestra el nombre del dominio, id de los contactos Comando: domcontacts

- Parámetros necesarios:

Apikey dominio tld

- Ejemplo del código para realizar la consulta:

<label>

Apikey

<br />

</label>

<label>

</label>

</form>

- Ejemplo de respuesta:

<command>domcontacts</command>

<domain>todopensiones.com</domain>

</response>

(6)

5. Ver los valores correspondientes a un id de contacto Comando: viewcontact

- Parámetros necesarios:

apikey id_contacto

- Ejemplo de código para realizar la consulta:

<label>

Apikey

<br />

Id Contacto

</label>

<label>

</label>

</form>

- Ejemplo de respuesta:

<command>viewcontact</command>

<name>VirtualName</name>

<company>VirtualName</company>

<email>[email protected]</email>

<address1>NoWhere</address1>

<state>Madrid</state>

<fax/>

</response>

(7)

6. Ver dns de un dominio Comando: domdns - Parámetros necesarios:

Apikey dominio tld

- Ejemplo del código para realizar la consulta:

<label>

Apikey

<br />

</label>

<label>

</label>

</form>

- Ejemplo de respuesta:

<command>domaindns</command>

<domain>todopensiones.com</domain>

<ns1>ns3.sourcecode.es</ns1>

<ns2>ns4.sourcecode.es</ns2>

</response>

(8)

7. Renovación de dominio Comando: renewdomain - Parámetros necesarios:

Apikey dominio tld anyos

- Ejemplo del código para realizar la consulta:

<label>

Apikey

<br />

</label>

<br />

Años

<label>

</label>

</form>

- Ejemplo de respuesta:

<command>renewdomain</command>

<domain>thyng.com</domain>

<text>thyng.com has been renewed for 2 years</text>

</response>

(9)

8. Añadir un contacto de dominio Comando: addcontact

¡ATENCIÓN! : este comando varía dependiendo del tld para el que se solicite, revise toda la documentación relativa a el.

- Parametros necesarios dominios gTLD:

Apikey name company email address1 city state country zip codtel tel codfax fax

- Ejemplo de código para realizar la consulta:

<table>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Nombre</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Organización</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Email</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Dirección</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Ciudad</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Provincia</td>

(10)

</tr>

<tr>

<option value="ES">Spain</option>

</select> </td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Código Postal</td>

( 5 cifras ) </td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">No Teléfono</td>

<td style="HEIGHT: 26px">+

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Numero Fax</td>

</tr>

</table>

<p>

<label>

Apikey

<br />

</label>

</p>

<p>

<label>

</label>

</p>

</form>

- Ejemplo de código de respuesta:

<command>addcontact</command>

<contact_id>8103060</contact_id>

<text>Contacto agregado</text>

</response>

(11)

-Parametros necesarios dominios .es (persona física)

** Con estos datos registra un contacto “persona física”… Los contactos administrativo, técnico y facturación SIEMPRE deben ser persona física.. El contacto titular podrá ser persona física o persona jurídica dependiendo del caso.. De tratarse de persona jurídica para el contacto titular lo comentado a continuación no vale.

Apikey name company email address1 city state country zip codtel tel codfax fax

id_type (tipo de documento, (cif, nif, nie) id_number (número de documento)

- Existe un id_type comodín que que se corresponde con value="0"

- El id_number debe ser correcto de lo contrario no permite seguir adelante a menos que se ponga el value comodín.

- Ejemplo de código para realizar la consulta:

<table>

<tr>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Organización</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Email</td>

( solo si no es títular )</td>

</tr>

<tr>

</tr>

<tr>

(12)

</tr>

<tr>

</tr>

<tr>

</select> </td>

</tr>

<tr>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">No Teléfono</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Documento</td>

</tr>

</table>

<p>

<label>

Apikey

<br />

</label>

</p>

<p>

<label>

</label>

</p>

</form>

- Ejemplo de código de respuesta:

(13)

</response>

(14)

-Parametros necesarios dominios .es (persona juridica)

** Con estos datos registra un contacto “persona jurídica” únicamente para el caso de contacto titular.

Apikey name address1 city state country zip

legal_form (forma juridica)

id_type (tipo de documento, (cif, nif, nie) id_number (número de documento)

- La forma jurídica incluye un listado de códigos para identificarla que deben ser respetados (se incluyen en el ejemplo de código).

- Existe un id_type comodín que se corresponde con value="0"

- El id_number debe ser correcto de lo contrario no permite seguir adelante a menos que se ponga el value comodín.

- Ejemplo de código para realizar la consulta:

<table>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

(15)

</select> </td>

</tr>

<tr>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Forma Jurídica </td>

<option value="39">Agrupacion de Interes Economico</option>

<option value="47">Asociacion</option>

<option value="59">Asociacion Deportiva</option>

<option value="68">Asociacion Gremial</option>

<option value="124">Caja de Ahorros</option>

<option value="150">Comunidad de Bienes</option>

<option value="152">Comunidad de Propietarios</option>

<option value="164">Congregacion o Institucion Religiosa</option>

<option value="878">Consejo Regulador de Denominacion de Origen</option>

<option value="181">Consulado</option>

<option value="197">Corporacion de Derecho Publico</option>

<option value="203">Embajada</option>

<option value="229">Entidad Local</option>

<option value="269">Federacion Deportiva</option>

<option value="286">Fundacion</option>

<option value="365">Mutua de Seguros</option>

<option value="745">Organismo Público Autonómico</option>

<option value="746">Organismo Público Estatal</option>

<option value="747">Organismo Público Local</option>

<option value="879">Organismos Gestor de Espacio Natural</option>

<option value="434">Organo de la Administracion Autonomica</option>

<option value="436">Organo de la Administracion del Estado</option>

<option value="877">Otras</option>

<option value="439">Partido Politico</option>

<option value="476">Sindicato</option>

<option value="510">Sociedad Agraria de Transformacion</option>

<option value="524">Sociedad Anonima</option>

<option value="525">Sociedad Anonima Deportiva</option>

<option value="744">Sociedad Anónima Laboral</option>

<option value="554">Sociedad Civil</option>

<option value="560">Sociedad Colectiva</option>

<option value="562">Sociedad Comanditaria</option>

<option value="566">Sociedad Cooperativa</option>

<option value="608">Sociedad Laboral Limitada</option>

<option value="612">Sociedad Limitada</option>

<option value="713">Sucursal en España</option>

<option value="717">Union Temporal de Empresas</option>

<option value="744">Sociedad Anónima Laboral</option>

<option value="745">Organismo Público Autonómico</option>

(16)

<option value="746">Organismo Público Estatal</option>

<option value="747">Organismo Público Local</option>

<option value="877">Otras</option>

<option value="878">Consejo Regulador de Denominación de Origen</option>

<option value="879">Organismo Gestor de Espacio Natural</option>

</select></td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Tipo Documento</td>

<option value="0">Otra identificación</option>

<option value="1">NIF - Número Identificación Fiscal</option>

<option value="2">CIF - Código Identificación Fiscal</option>

<option value="3">NIE - Número Identificación Extranjero</option>

</select>

</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Documento</td>

</tr>

</table>

<p>

<label>

Apikey

<br />

</label>

</p>

<p>

<label>

</label>

</p>

</form>

- Ejemplo de código de respuesta:

</response>

(17)

9. Registrar un dominio Comando: registerdomain - Datos necesarios:

Apikey dominio tld anyos registrant_id admin_id tech_id fact_id dns1 dns2

dns3 (opcional) dns4 (opcional)

- Ejemplo de código para realizar la consulta:

Nota: Para modo pruebas solo se pueden usar las dns siguiente: ns1.test.com, ns2.test.com y ns3.test.com

<label>

Apikey

<br />

</label>

<br />

Años

<br />

Registrante:

<br />

Admin:

<br />

Tecnico:

<br />

Facturación:

<br />

DNS1:

<br />

(18)

DNS2:

<br />

<label>

</label>

</form>

- Ejemplo de código de respuesta:

<command>registerdomain</command>

<text>Se ha registrado el dominio test.com</text>

</response>

(19)

10. Transferir un dominio Comando: transferdomain

** Este comando no permite prueba en entorno demo

- Parámetros necesarios:

apikey dominio tld

authcode (no se usa para los “.es”) id_contacto (no se usa para los “.es”)

- Ejemplo de código para realizar la consulta:

<label>

Apikey

<br />

</label>

<br />

Secret:

<br />

id contacto

<br />

<label>

</label>

</form>

- Ejemplo de código de respuesta:

<command>transferdomain</command>

<text> Se ha iniciado la transferencia del dominio test.com</text>

</response>

(20)

11. Modificar DNS de un dominio Comando: modifydns

- Parámetros necesarios:

apikey dominio tld dns1 dns2

dns3 (opcional) dns4 (opcional)

- Ejemplo de código para realizar la consulta:

<body>

<form id="form1" name="form1" method="get"

action="http://api.extranetdeclientes.com/apidemo/api.php">

<input name="apikey" type="text" id="apikey" />

Apikey

<input name="act" type="hidden" id="act" value="modifydns" />

<br />

<input type="text" name="dominio" id="dominio" />

<input name="tld" type="text" id="tld" size="5" />

<br />

ns1:

<input type="text" name="dns1" id="dns1" />

<br />

ns2:

<input type="text" name="dns2" id="dns2" />

<br />

ns3:

<input type="text" name="dns3" id="dns3" />

<br />

ns4:

<input type="text" name="dns4" id="dns4" />

<br />

<input type="submit" name="Enviar" id="Enviar" value="Enviar" />

</form>

</body>

(21)

- Ejemplo de código de respuesta:

<response>

<command>modifydns</command>

<text>Se han modificado las DNS</text>

<estado>true</estado>

</response>

(22)

12. Ver vencimiento de un dominio Comando: viewdomaininfo

- parámetros necesarios:

apikey dominio tld

- Ejemplo de código para realizar la consulta:

<body>

<form id="form1" name="form1" method="get"

action="http://api.extranetdeclientes.com/apidemo/api.php">

<label>

<input name="apikey" type="text" id="apikey" />

Apikey

<input name="act" type="hidden" id="act" value="viewdomaininfo" />

<br />

<input type="text" name="dominio" id="dominio" />

</label>

<input name="tld" type="text" id="tld" size="5" />

<label>

<input type="submit" name="Enviar" id="Enviar" value="Enviar" />

</label>

</form>

</body>

- Ejemplo de código de respuesta:

<response>

<command>viewdomaininfo</command>

<domain>todopensiones.com</domain>

<registrado>Sat, 3 May 2008 01:28:17 +0200</registrado>

<caduca>Mon, 3 May 2010 01:28:17 +0200</caduca>

</response>

(23)

13. Modificar los datos de un contacto (NO DISPONIBLE DOMINIOS .ES)

* Para modificar un contacto en .es lo que haremos es crear un nuevo contacto y sustituir el actual por el nuevo.

Comando: modifycontact - Parámetros necesarios:

pikey id_contacto name

company ( Si no se introduce nada se queda como N/D) email

address1 city state country zip codtel tel codfax fax

- Ejemplo de código para realizar la consulta:

<body>

<form id="propietario" method="get"

action="http://api.extranetdeclienes.com/apidemo/api.php">

<table>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Nombre</td>

<td style="HEIGHT: 26px"><input name="name" type="text" id="name" value="" /></td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Organización</td>

<td style="HEIGHT: 26px"><input name="company" type="text" id="company" value="" />

</td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Email</td>

<td style="HEIGHT: 26px"><input name="email" type="text" id="email" value="" /> </td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Dirección</td>

<td style="HEIGHT: 26px"><input name="address1" type="text" id="address1" value=""

(24)

/></td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Ciudad</td>

<td style="HEIGHT: 26px"><input name="city" type="text" id="city" value="" /></td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Provincia</td>

<td style="HEIGHT: 26px"><input name="state" type="text" id="state" value="" /> </td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">País</td>

<td style="HEIGHT: 26px"> <select name="country" id="country">

<option value="ES">Spain</option>

</select> </td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Código Postal</td>

<td style="HEIGHT: 26px"><input name="zip" type="text" id="zip" value=""/>

( 5 cifras ) </td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">No Teléfono</td>

<td style="HEIGHT: 26px">+

<input name="codtel" type="text" id="telNoCc" value="" size="2" />

<input name="tel" type="text" id="telNo" value="" /> </td>

</tr>

<tr>

<td style="WIDTH: 197px; HEIGHT: 26px">Numero Fax</td>

<td style="HEIGHT: 26px">+

<input name="codfax" type="text" id="faxNoCc" size="2" value="" />

<input name="fax" type="text" id="faxNo" value="" /> </td>

</tr>

</table>

<br />

<input name="contact_id" type="text" id="contact_id" />

Id Contacto <br />

<p>

<label>

<input name="apikey" type="text" id="apikey" />

Apikey

<input name="act" type="hidden" id="act" value="modifycontact" />

<br />

</label>

(25)

</p>

<p>

<label>

<input type="submit" name="ir" id="ir" value="Enviar" />

</label>

</p>

</form>

</body>

- Ejemplo de código de respuesta:

<response>

<command>modifycontact</command>

<text>Contacto modificado</text>

</response>

(26)

14. Ver auth code de un dominio (NO DISPONIBLE DOMINIOS .ES) Comando:

viewsecret

- Parámetros necesarios:

apikey dominio tld

- Ejemplo de código para realizar la consulta:

<body>

<form id="form1" name="form1" method="get"

action="http://api.extranetdeclientes.com/apidemo/api.php">

<label>

<input name="apikey" type="text" id="apikey" />

Apikey

<input name="act" type="hidden" id="act" value="viewsecret" />

<br />

<input type="text" name="dominio" id="dominio" />

</label>

<input name="tld" type="text" id="tld" size="5" />

<label>

<input type="submit" name="Enviar" id="Enviar" value="Enviar" />

</label>

</form>

</body>

- Ejemplo de código de respuesta:

<?xml version="1.0" ?>

- <response>

<command>viewsecret</command>

<domain>dominio.com</domain>

<authcode>k7daYtUbxL</authcode>

</response>

(27)

15. Modificar los contactos de un dominio Comando: modifydomaincontacts

- Parámetros necesarios:

apikey dominio tld

registrant_id (en los dominios .es no se tiene en cuenta este campo que no se puede modificar por api, requiere documentación remitida al esnic firmada)

admin_id tech_id fact_id

- Ejemplo de código para realizar la consulta:

<form id="form1" name="form1" method="get"

action="http://api.extranetdeclientes.com/apidemo/api.php">

<label>

<input name="apikey" type="text" id="apikey" />

Apikey

<input name="act" type="hidden" id="act" value="modifydomaincontacts" />

<br />

<input type="text" name="dominio" id="dominio" />

</label>

<input name="tld" type="text" id="tld" size="5" />

<br />

Registrante:

<input type="text" name="registrant_id" id="registrant_id" />

<br />

Admin:

<input type="text" name="admin_id" id="admin_id" />

<br />

Tecnico:

<input type="text" name="tech_id" id="tech_id" />

<br />

Facturación:

<input type="text" name="fact_id" id="fact_id" />

<br />

<label>

<input type="submit" name="Enviar" id="Enviar" value="Enviar" />

</label>

</form>

(28)

- Ejemplo de código de respuesta:

<?xml version="1.0"?>

<response>

<command>modifydomaincontacs</command>

<domain>todopensiones.com</domain>

<text>Se han modificado los contactos del dominio</text>

</response>

(29)

16.- Listado de códigos de error 201 = ApiKey Invalida

202 = No es posible realizar transferencias en modo demo 203 = Comando incorrecto

204 = Dominio disponible 205 = Dominio no disponible

206 = El dominio no esta bajo tu cuenta o no está registrado con nosotros 207 = No tienes permiso para modificar este dominio

208 = Se han modificado las DNS

209 = No se han podido modificar las DNS 210 = No existe ese contacto

211 = El id del contacto debe ser un valor numérico 212 = No tienes permiso para modificar este contacto 213 = No tienes permiso para renovar este dominio 214 = El dominio ha sido renovado

215 = No se ha podido renovar el dominio 216 = El nombre es obligatorio

217 = El email es obligatorio 218 = La dirección es obligatoria 219 = La ciudad es obligatoria 220 = La provincia es obligatoria 221 = El país es obligatorio