API Grandes Cuentas Guía de referencia Comandos API. V Departamento de Atención al Cliente

Transcripción

1 API Grandes Cuentas Guía de referencia Comandos API V Departamento de Atención al Cliente

2 Comandos de la API Salvo que se indique lo contrario todos los comandos compartirán 3 parámetros que deben ir en todas las peticiones, estos son: uid: Es tu nombre de usuario en grandes cuentas de dinahosting. pw: Es tu password en grandes cuentas de dinahosting command: Es el comando a ejecutar. Estos comandos se dividen en 2 grandes grupos, comandos de gestión de dominios y comandos de administración, los primeros te permitirán gestionar contactos, zonas, etc, de tus dominios mientras que el segundo grupo está enfocado al registro, renovación o traslado de dominios.

3 dom_setourdns Establece los servidores de Dinahosting como Servidores dns del dominio. sld Requerido Sld del Dominio tld Requerido Tld del Dominio devueltos y valores Si ErrCount>0, en Err(1 a ErrCount) se indican los errores string true Indica que todo se ha realizado correctamente false lo contrario <Command>dom_setOurDNS</Command>

4 dom_setdomainparking Establece la página a mostrar si el dominio se aparca. sld Requerido Sld del Dominio tld Requerido Tld del Dominio Title Requerido Titulo de la página, donde se indica que el dominio está aparcado Description Requerido Contenido de la página que se muestra si el dominio está aparcado. Permite etiquetas HTML devueltos y valores <Command>dom_setDomainParking</Command>

5 dom_setredirecturl Establece la redirección a la que queremos que apunte el dominio. Type Requerido Tipo de Redirección (enum( FRAME, URL )) Url Requerido Dirección de Internet a la que queremos que apunte el dominio (string) Title Optativo Definimos los metatags de la Redirección (string) Description Optativo Definimos los metatags de la Redirección (string) Keywords Optativo Definimos los metatags de la Redirección (string) devueltos y valores <Command>dom_setRedirectURL</Command>

6 dom_registerdns Registra un servidor dns. Dns Requerido Servidor dns que se quiere registrar (string) Ip Requerido Dirección ip del Servidor dns (string) devueltos y valores <Command>dom_registerDns</Command>

7 dom_get redirect Obtiene las redirecciónes de correo asociadas a un dominio. devueltos y valores alias Alias de la Cuenta de Correo que redireccionamos string redirection-to Cuenta de correo a la que se redirecciona string Número de Cuentas de Correo Redirigidas string <redirection> <alias>tualias</alias> <redirection-to>tucorreo@tudominio.es</redirection-to> </redirection> <redirection> <alias>tuotroalias</alias> <redirection-to>otrocorreo@otrodominio.es</redirection-to> </redirection> < Count>2</ Count> <Command>dom_get Redirect</Command>

8 dom_updatepassword Actualiza el password del panel de control de dominios. NewPassword Requerido Nueva Clave para el Panel de Dominio (string) devueltos y valores <Command>dom_updatePassword</Command>

9 dom_delete redirect Elimina todos los s redirigidos que tiene un dominio. devueltos y valores <Command>dom_delete Redirect</Command>

10 dom_updatedns Actualiza la ip de un Servidor dns registrado. Dns Requerido Servidor dns al que se quiere actualizar la ip (string) Ip Requerido Nueva Dirección ip del Servidor dns (string) Ip_old Requerido Actual Dirección ip del Servidor dns (string) devueltos y valores <Command>dom_updateDns</Command>

11 dom_setzones Establece las zonas de los Servidores dns de un dominio. Host{i} Requerido Define una zona de los Servidores dns. Si el Type es MXD1 o MXD2 no se indica Host. i={1,2,3,4,...} Si sólo se indica una zona no lleva el índice (string) Type{i} Requerido Indica el tipo de la zona, i={1,2,3,4,...} Si sólo se indica una zona no lleva el índice.(enum( A, CNAME, URL, FRAME, MXS, MXD 1, MXD2, spf )) Address{i} Requerido Define a donde apunta la zona definida. Según el tipo tendrá que tener unos valores u otros. i={1,2,3,4,...} Si sólo se indica una zona no lleva el índice (string) NumZones Requerido Indica el número de zonas definidas (int) devueltos y valores <Command>dom_setZones</Command>

12 dom_deleteredirecturl Elimina la redirección que tiene un dominio. devueltos y valores <Command>dom_deleteRedirectURL</Command>

13 dom_setdns Establece como Servidores dns del dominio, los Servidores dns indicados. (Si el dominio es de Esnic, aunque haya servidores que no se establezcan pueden que otros se establezcan con el dominio, aunque se devolverá fallo en el comando) Dns{i} Requerido Servidor dns que se establece como Servidor dns del dominio, i={1,2,3,4} minimo=2, maximo=4 (string) devueltos y valores <Command>dom_setDNS</Command>

14 dom_getcontacts Obtiene las contactos asociados a un dominio. devueltos y valores {ContactType}FirstName Nombre del contacto string {ContactType}LastName Apellidos del contacto string {ContactType}Address1 Dirección del contacto string {ContactType}City Ciudad del contacto string {ContactType}StateProvince Estado o Provincia del contacto string {ContactType}Country País del contacto string {ContactType} Address del contacto string {ContactType}OrganizationName Nombre de la Organización a la que pertenece el string contacto {ContactType}Phone Teléfono del contacto. string {ContactType}PostalCode Código Postal del contacto string {ContactType}Fax Forma Jurídica de la Organización del contacto string {ContactType}FormaJurídica Forma Jurídica de la Organización del contacto. string Sólo en los dominio.es {ContactType}Identificacion Identificacion (nif, nie, o cif) del contacto. Sólo en string los dominio.es CodeText Texto descriptivo que explica la ejecución del string comando. Si ErrCount>0, en Err(1 a ErrCount) se indican los string errores Nota: {ContactType} puede tener los siguientes valores: Registrant, Admin, Tech, Billing.

15 <Registrant> <RegistrantFirstName>Nombre</RegistrantFirstName> <RegistrantLastName>Apellido</RegistrantLastName> <RegistrantAddress1>Dirección</RegistrantAddress1> <RegistrantCity>Ciudad</RegistrantCity> <RegistrantCountry>ES</RegistrantCountry> </Registrant Address> <RegistrantFax> </RegistrantFax> <RegistrantOrganizationName>Organización </RegistrantOrganizationName> <RegistrantPhone> </RegistrantPhone> <RegistrantPostalCode>08080</RegistrantPostalCode> <RegistrantStateProvince>00</RegistrantStateProvince> </Registrant> <Admin> <AdminAddress1>Dirección</AdminAddress1> <AdminCity>Ciudad</AdminCity> <AdminCountry>ES</AdminCountry> <AdminFax> </AdminFax> <AdminFirstName>Nombre</AdminFirstName> <AdminLastName>Apellido</AdminLastName> <AdminOrganizationName>Organización</AdminOrganizationName> <AdminPhone> </AdminPhone> <AdminPostalCode>08080</AdminPostalCode> <AdminStateProvince>00</AdminStateProvince> </Admin> <Tech> <TechAddress1>Dirección</TechAddress1> <TechCity>Ciudad</TechCity> <TechCountry>ES</TechCountry> <TechFax> </TechFax> <TechFirstName>Nombre</TechFirstName> <TechLastName>Apellidos</TechLastName> <TechOrganizationName>Organización</TechOrganizationName> <TechPhone> </TechPhone> <TechPostalCode>08080</TechPostalCode> <TechStateProvince>00</TechStateProvince> </Tech> <Billing> <BillingAddress1>Dirección</BillingAddress1> <BillingCity>Ciudad</BillingCity> <BillingCountry>ES</BillingCountry> <BillingFax> </BillingFax> <BillingFirstName>Nombre</BillingFirstName> <BillingLastName>Apellido</BillingLastName> <BillingOrganizationName>Organización</BillingOrganizationName> <BillingPhone> </BillingPhone> <BillingPostalCode>08080</BillingPostalCode> <BillingStateProvince>00</BillingStateProvince>

16 </Billing> <Command>dom_getContacts</Command> <Command>dom_setDomainParking</Command>

17 dom_set redirect Crea redirecciónes de correo. Alias AliasList Requerido Redirection RedirectionList Requerido Si se crea más de una Redirección de Correo se utiliza AliasList, que contendrá alias (lo que se anteponde a en una dirección de co rreo) separados por comas, si sólo se crea una Redirección de Correo utilizamos Alias (string) Si se crea más de una Redirección de Correo se utiliza RedirectionList, que contendrá cuentas de correo separadas por comás, si sólo se crea una Redirección de Correo utilizamos Redirection. (string) devueltos y valores <Command>dom_setDomainParking</Command>

18 dom_getredirecturl Obtiene las redirecciónes asociadas a un dominio. devueltos y valores Type Tipo de la Redirección (enum( FRAME, URL )) Url Url a la que redirecciona string title Si Type=FRAME se puede indicar los metatags de la string redirección description Si Type=FRAME se puede indicar los metatags de la string redirección keywords Si Type=FRAME se puede indicar los metatags de la string redirección <Type>FRAME</Type> <Url> <title>título de la página</title> <decription>descripción de la página </decription> <keywords>palabras clave a utilizar</keywords> </redirecturl> <Command>dom_getRedirectURL</Command>

19 dom_contacts Devuelve los contactos de un dominio uid Requerido Usuario del Dominio(string) pw Requerido Clave del Dominio(string) sld Requerido Sld del Dominio(string) tld Requerido Tld del Dominio(string) ContactType Optativo Cuando se pasan sólo los datos de uno de los contac tos, para modificarlo, con este parametro se indica de que contacto se trata.(enum( Registrant, Admin, Tec h, AuxBilling )) {ContactType}FirstName Requerido Nombre del contacto. Si hay más de un contacto es cuando se indica {ContactType}.(string) {ContactType}LastName Requerido Apellidos del contacto. Si hay más de un contacto es cuando se indica {ContactType}.(string) {ContactType}Address Requerido Dirección del contacto. Si hay más de un contacto es cuando se indica {ContactType}.(string) {ContactType}City Requerido Población del contacto. Si hay más de un contacto es cuando se indica {ContactType}.(string) {ContactType}StateProvince Requerido Provincia del contacto. Si hay más de un contacto es cuando se indica {ContactType}.(string) {ContactType}PostalCode Requerido Código Postal del contacto. Si hay más de un contac to es cuando se indica {ContactType}.(string) {ContactType}Country Requerido País del contacto. Si hay más de un contacto es cuan do se indica {ContactType}.(string) {ContactType}Phone Requerido Teléfono del contacto. Si hay más de un contacto es cuando se indica {ContactType}.(string) {ContactType}Fax Requerido Fax del contacto. Si hay más de un contacto es cuan do se indica {ContactType}.(string) {ContactType} Address Requerido del contacto. Si hay más de un contacto es cuando se indica {ContactType}.(string) {ContactType}OrganizationName Requerido Empresa del contacto. Si hay más de un contacto es cuando se indica {ContactType}. (string) devueltos y valores

20 <Command>contacts</Command>

21 dom_getdomainparking Obtiene las datos que tiene un dominio aparcado. devueltos y valores Title Titulo de la página string Description Mensaje que deseas que aparezca en la página. string <Command>parking</Command>

22 dom_deletezones Elimina las zonas de los servidores dns de un dominio. devueltos y valores <Command>dom_deleteZones</Command>

23 dom_getdns Devuelve las DNS asociadas al dominio. devueltos y valores dns Servidor Dns del dominio. string DnsCount Número de Servidores Dns asociados al dominio. string <dns>ns.gestiondecuenta.com</dns> <dns>ns2.gestiondecuenta.com</dns> <dns>ns3.gestiondecuenta.com</dns> <dns>ns4.gestiondecuenta.com</dns> <DnsCount>4</DnsCount> <Command>dom_getDNS</Command>

24 dom_getzones Obtiene las zonas asociadas a los servidores dns de un dominio. devueltos y valores host Nombre de la zona definida string type Tipo de la zona definida enum( A, redi, fram, cna m, 'spf, '') address Dirección o ip a la que apunta la zona. string ZonesCount Número de zonas definidas. string

25 <zone> <type>a</type> <address> </address> </zone> <zone> <host>ftp</host> <type>a</type> <address> </address> </zone> <zone> <host>mail</host> <type>a</type> <address> </address> </zone> <zone> <host>www</host> <type>a</type> <address> </address> </zone> <ZonesCount>4</ZonesCount> <Command>dom_getZones</Command>

26 register Registra un dominio para un usuario dado de Grandes cuentas. uid Requerido Usuario del Dominio(string) pw Requerido Clave del Dominio(string) sld Requerido Sld del Dominio(string) command Requerido Comando utilizado (string) years Requerido Número de años de registro. (int) contactoregnombre No requerido Nombre contacto registrante contactoregapellidos No requerido Apellidos contacto registrante contactoregdirección No requerido Dirección contacto registrante contactoregprovincia No requerido Provincia contacto registrante contactoregpoblación No requerido Población contacto registrante contactoregempresa No requerido Empresa contacto registrante contactoregpaís No requerido País contacto registrante contactoregcp No requerido Código Postal contacto registrante contactoregteléfono No requerido Teléfono contacto registrante contactoreg No requerido contacto registrante contactoregformajurídica No requerido Forma jurídica contacto registrante contactoadminnombre No requerido Nombre contacto Administrativo contactoadminapellidos No requerido Apellidos contacto Administrativo contactoadmindirección No requerido Dirección contacto Administrativo contactoadminprovincia No requerido Provincia contacto Administrativo contactoadminpoblación No requerido Población contacto Administrativo contactoadminempresa No requerido Empresa contacto Administrativo contactoadminpaís No requerido País contacto Administrativo contactoadmincp No requerido Código Postal contacto Administrativo contactoadminteléfono No requerido Teléfono contacto Administrativo contactoadmin No requerido contacto Administrativo contactoadminformajurídica No requerido Forma jurídica contacto Administrativo contactobillnombre No requerido Nombre contacto Facturación contactobillapellidos No requerido Apellidos contacto Facturación contactobilldirección No requerido Dirección contacto Facturación contactobillprovincia No requerido Provincia contacto Facturación contactobillpoblación No requerido Población contacto Facturación contactobillempresa No requerido Empresa contacto Facturación contactobillpaís No requerido País contacto Facturación contactobillcp No requerido Código Postal contacto Facturación contactobillteléfono No requerido Teléfono contacto Facturación contactobill No requerido contacto Facturación contactobillformajurídica No requerido Forma jurídica contacto Facturación contactotechnombre No requerido Nombre contacto Técnico contactotechapellidos No requerido Apellidos contacto Técnico contactotechdirección No requerido Dirección contacto Técnico contactotechprovincia No requerido Provincia contacto Técnico contactotechpoblación No requerido Población contacto Técnico contactotechempresa No requerido Empresa contacto Técnico contactotechpaís No requerido País contacto Técnico contactotechcp No requerido Código Postal contacto Técnico

27 contactotechteléfono No requerido Teléfono contacto Técnico contactotech No requerido contacto Técnico contactotechformajurídica No requerido Forma jurídica contacto Técnico codautorizacat No requerido Código de autorización para.cat identifclavecat No requerido Identificador de clave para.cat usodominiocat No requerido Futuro uso del dominio.cat dns-1 No requerido Servidor DNS primario del dominio dns-2 No requerido Servidor DNS secundario del dominio dns-3 No requerido Servidor DNS terciario del dominio dns-4 No requerido Servidor DNS cuaternario del dominio devueltos y valores expirationdate Devuelve la fecha de fin en formato YYYY-MM-DD <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount> <errors/> <?xml version= 1.0 encoding= utf-8?> <Code>2009</Code> <errcount>1</errcount> <errors> <error>service_not_register</error> </errors>

28 renew Renueva un dominio para un usuario dado de Grandes cuentas. devueltos y valores expirationdate Devuelve la fecha de fin en formato YYYY-MM-DD <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount> <errors/> <expirationdate> </expirationdate> <?xml version= 1.0 encoding= utf-8?> <Code>2009</Code> <errcount>1</errcount> <errors> <error>service_not_register</error> </errors>

29 transfer Inicia una transferencia de dominio para un usuarios de Grandes cuentas. authcode No requerido Auth-code (string) devueltos y valores Si ErrCount>0, en Err(1 a ErrCount) se indican los errores string <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount> <errors/> <?xml version= 1.0 encoding= utf-8?> <Code>2009</Code> <errcount>1</errcount> <errors> <error>service_not_register</error> </errors>

30 expirationdate Devuelve fecha de fin del servicio, un dominio activo en dinahosting. devueltos y valores expirationdate Devuelve la fecha de fin en formato YYYY-MM-DD <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount> <errors/> <expirationdate> </expirationdate> <?xml version= 1.0 encoding= utf-8?> <Code>2005</Code> <errcount>1</errcount> <errors> <error>service_not_found</error> </errors>

31 transferconsult Devuelve el estado actual de la transferencia de un dominio de un usuario de Grandes cuentas. devueltos y valores transferstate Devuelve el estado de la transferencia de dominio

32 <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount> <errors/> <transferstate>transfer_ok</transferstate> <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount><errors/> <transferstate>transfer_state_unknow (ENOM_ERROR_SINRESPUESTA_CMD_GETESTADO- TRANSFER)</transferState> <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount> <errors/> <transferstate>transfer_waiting</transferstate> <?xml version= 1.0 encoding= utf-8?> <Code>2005</Code> <errcount>1</errcount> <errors> <error>service_not_found</error> </errors>

33 check Consulta la disponibilidad de registro de un dominio. devueltos y valores <?xml version= 1.0 encoding= utf-8?> <Code>1000</Code> <errcount>0</errcount> <errors/> <?xml version= 1.0 encoding= utf-8?> <Code>4001</Code> <errcount>1</errcount> <errors> <error>domain_not_available</error> </errors>

34 COPYRIGHT 2007 DINAHOSTING S.L.

35