Saltar a: navegación, buscar

Diferencia entre revisiones de «API de números»

(→‎Ejemplo de listado de contactos en XML)
 
(No se muestran 9 ediciones intermedias de 3 usuarios)
Línea 1: Línea 1:
−
==¿Qué es?==
+
{{#seo:
 +
|title= API {{PROD_TILDE}}.
 +
|titlemode=append
 +
|keywords=numeros de centralitas, etiqueta numero virtual, Api, aplicaciones y desarrollo, herramientas web, desarrollo herramientas, API telefonia, modulo de telefonia, integracion software, API desarrollador
 +
|description=API de números: Herramientas de desarrollado para integrar la telefonía en aplicaciones web. Integre su línea telefónica virtual con APIs.
 +
}}
  
−
===Descripción===
 
  
−
Este servicio web nos permite listar los números de Oficina Virtual (números virtuales, centralitas, faxes) de una cuenta {{PRODUCTO}}.
+
==¿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 {{PRODUCTO}}.
 +
 
 +
Si no sabe lo que es una API lea [[que es una api|¿Qué son las APIs de {{PRODUCTO}}?]]
  
 
==Forma de uso==
 
==Forma de uso==
  
  
−
===Lista de contactos===
+
====Lista de números====
  
−
Devuelve la lista de contactos (en XML).
+
Devuelve la lista de números de teléfonos (en XML).
  
 
La URL debe ser:
 
La URL debe ser:
  
−
https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/apinumeros?principal=xxxxxxxxx&pin=xxxx
+
https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/apinumeros?principal=xxxxxxxxx&pass=xxxxxxxx
  
 
donde:
 
donde:
  
 
* 'principal' es su número de usuario de {{PRODUCTO}}.
 
* 'principal' es su número de usuario de {{PRODUCTO}}.
−
* 'pin' es el PIN de la cuenta.
+
* 'pass' es la contraseña de la cuenta.
  
  
−
===Respuesta del servicio===
+
===Respuesta del servicio API===
  
 
El servicio web retorna todas las respuestas en formato [http://es.wikipedia.org/wiki/Extensible_Markup_Language 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.
 
El servicio web retorna todas las respuestas en formato [http://es.wikipedia.org/wiki/Extensible_Markup_Language 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.
Línea 28: Línea 38:
 
Por ejemplo, una respuesta afirmativa sería:
 
Por ejemplo, una respuesta afirmativa sería:
  
−
HTTP/1.1 200 OK
+
<pre>HTTP/1.1 200 OK
 
  Date: Mon, 20 Feb 2012 11:43:37 GMT
 
  Date: Mon, 20 Feb 2012 11:43:37 GMT
 
  Server: Apache
 
  Server: Apache
Línea 40: Línea 50:
 
  <numeros>
 
  <numeros>
 
   <error>0</error>
 
   <error>0</error>
−
  </numeros>
+
  </numeros></pre>
  
 
Una respuesta de error sería:
 
Una respuesta de error sería:
  
−
HTTP/1.1 200 OK
+
<pre>HTTP/1.1 200 OK
 
  Date: Mon, 20 Feb 2012 11:43:37 GMT
 
  Date: Mon, 20 Feb 2012 11:43:37 GMT
 
  Server: Apache
 
  Server: Apache
Línea 58: Línea 68:
 
   <msgerr>Cuenta incorrecta.</msgerr>
 
   <msgerr>Cuenta incorrecta.</msgerr>
 
  </numeros>
 
  </numeros>
 +
</pre>
  
−
 
+
==Ejemplos de uso API==
−
==Ejemplos==
 
  
 
===Ejemplo de llamada al servicio web en PHP + CURL===
 
===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 pin simplemente mirando el código HTML.
+
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.
 
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:
 
He aquí un ejemplo en PHP usando cURL, cortesía de tuayudainformatica.com:
−
 
+
<pre>
 
  <?php
 
  <?php
 
   $usuario = '666111666';
 
   $usuario = '666111666';
−
   $pin = '0000';
+
   $pass = 'miClaveSecreta';
 
   
 
   
 
   $curl = curl_init("https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/apinumeros?
 
   $curl = curl_init("https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/apinumeros?
−
                       principal=${usuario}&pin=${pin}"); // LLAMADA DE LA URL
+
                       principal=${usuario}&pass=${pass}"); // LLAMADA DE LA URL
 
   curl_setopt($curl, CURLOPT_HEADER, false);  // PARA EVITAR DEVOLUCION DE CABEZERAS HTTP
 
   curl_setopt($curl, CURLOPT_HEADER, false);  // PARA EVITAR DEVOLUCION DE CABEZERAS HTTP
 
   curl_setopt($curl, CURLOPT_TIMEOUT, 5);    // TIEMPO DE ESPERA   
 
   curl_setopt($curl, CURLOPT_TIMEOUT, 5);    // TIEMPO DE ESPERA   
Línea 82: Línea 92:
 
   $output = substr($output, 0, 1);            // XML
 
   $output = substr($output, 0, 1);            // XML
 
  ?>
 
  ?>
 +
</pre>
  
 +
===Ejemplo de listado de números en XML===
  
−
===Ejemplo de listado de contactos en XML===
+
<pre>
−
 
 
−
 
 
 
<?xml version="1.0" encoding="UTF-8" ?>
 
<?xml version="1.0" encoding="UTF-8" ?>
  
Línea 108: Línea 118:
 
  </numeros>
 
  </numeros>
  
−
 
+
</pre>
  
 
----
 
----
Línea 116: Línea 126:
 
'''Indice'''
 
'''Indice'''
  
−
[[Portada]]  >>  [[Desarrolladores]]  >>  API de números.
+
[[Página principal]]  >>  [[Desarrolladores]]  >>  API de números.

Revisión actual del 12:13 2 jul 2021


¿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 Telefácil.

Si no sabe lo que es una API lea ¿Qué son las APIs de Telefácil?

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/telefacil2/apinumeros?principal=xxxxxxxxx&pass=xxxxxxxx

donde:

  • 'principal' es su número de usuario de Telefácil.
  • '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.

Obtenido de «https://telefacil.duocom.es/wiki/index.php?title=API_de_números&oldid=18683»