API de números

¿Qué es API de números?

Descripción de API

Este servicio web nos permite listar los números de teléfonos de Oficina Virtual (números virtuales, números de centralitas, faxes) de una cuenta Mi Oficina Web.

Si no sabe lo que es una API lea ¿Qué son las APIs de Mi Oficina Web?

Forma de uso

Lista de números

Devuelve la lista de números de teléfonos (en XML).

La URL debe ser:

https://scgi.duocom.es/cgi-bin/oficinaweb/apinumeros?principal=xxxxxxxxx&pass=xxxxxxxx

donde:

• 'principal' es su número de usuario de Mi Oficina Web.
• 'pass' es la contraseña de la cuenta.

Respuesta del servicio API

El servicio web retorna todas las respuestas en formato XML. Todas las respuestas están encerradas en la raíz 'numeros', y contiene siempre un campo 'error' que será 0 si el comando o petición enviado al servidor se ejecutó con éxito, o 1 si hubo algún error, en cuyo caso habrá también un campo 'msgerr' que explica dicho error.

Por ejemplo, una respuesta afirmativa sería:

HTTP/1.1 200 OK
 Date: Mon, 20 Feb 2012 11:43:37 GMT
 Server: Apache
 Keep-Alive: timeout=15, max=100
 Connection: Keep-Alive
 Transfer-Encoding: chunked
 Content-Type: text/xml
 
 <?xml version="1.0" encoding="UTF-8" ?>
 
 <numeros>
   <error>0</error>
 </numeros>

Una respuesta de error sería:

HTTP/1.1 200 OK
 Date: Mon, 20 Feb 2012 11:43:37 GMT
 Server: Apache
 Keep-Alive: timeout=15, max=100
 Connection: Keep-Alive
 Transfer-Encoding: chunked
 Content-Type: text/xml
 
 <?xml version="1.0" encoding="UTF-8" ?>
 
 <numeros>
   <error>1</error>
   <msgerr>Cuenta incorrecta.</msgerr>
 </numeros>

Ejemplos de uso API

Ejemplo de llamada al servicio web en PHP + CURL

Tenga presente que, aunque la aplicación web es accesible mediante una URL, no debe poner nunca enlaces a esta aplicación directamente en el código fuente de sus páginas web, ya que sus visitantes podrían descubrir datos sensibles como su número de usuario y su contraseña simplemente mirando el código HTML.

La aplicación web debe ser llamada siempre desde el servidor, usando para ello alguna de las librerías que permite llamadas a servicios HTTPS.

He aquí un ejemplo en PHP usando cURL, cortesía de tuayudainformatica.com:

 <?php
   $usuario = '666111666';
   $pass = 'miClaveSecreta';
 
   $curl = curl_init("https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/apinumeros?
                      principal=${usuario}&pass=${pass}"); // LLAMADA DE LA URL
   curl_setopt($curl, CURLOPT_HEADER, false);  // PARA EVITAR DEVOLUCION DE CABEZERAS HTTP
   curl_setopt($curl, CURLOPT_TIMEOUT, 5);     // TIEMPO DE ESPERA   
   $output = curl_exec($curl);                 // EJECUTAMOS LA LLAMADA
   curl_close($curl);
   $output = substr($output, 0, 1);            // XML
 ?>

Ejemplo de listado de números en XML

<?xml version="1.0" encoding="UTF-8" ?>

 <numeros>
  <error>0</error>
  <numero>
    <telefono>902009955</telefono>
    <tipo>Numero Virtual</tipo>
    <etiqueta>Mi numero virtual</etiqueta>
  </numero>
  <numero>
    <telefono>902001001</telefono>
    <tipo>Centralita</tipo>
    <etiqueta>Mi numero de centralita</etiqueta>
  </numero>
  <numero>
    <telefono>902009956</telefono>
    <tipo>Fax</tipo>
    <etiqueta>Mi numero de fax</etiqueta>
  </numero>
 </numeros>

---

---

Indice

Página principal >> Desarrolladores >> API de números.