|
Sección: Descripción
Tabla de contenidos
1. Audiencia
Esta documentación está escrita para personas con conocimientos de programación de
JavaScript y conceptos de programación orientada a objetos. Información detallada de clases
y métodos se pueden encontrar en: Documentación de clases y métodos.
2. Introducción
El "Hello World" de API.Planos
La manera más simple de iniciar el aprendizaje de API.Planos es
revisar el siguiente ejemplo. La página web despliega un
plano de 600x400 pixeles, centrado en las coordenadas de la Plaza de Armas, Santiago:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>API.Planos JavaScript API Ejemplo</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<script language="javascript"
src="http://apiplanos.amarillas.cl/planosapi/api/js/reqapis/Apis?key=8%2BRYpfWcDBd7Rbj4inwvDypltNMOrwOd&v=1.3">
</script>
<script language="Javascript">
function load() {
var map = new Map("map");
map.draw(new GeoPoint(-33.437184, -70.649728), 3);
}
</script>
</head>
<body onload="load()">
<div id="map" style="position:absolute; left:50px; top:50px; width: 600px;
height: 400px; border-style:solid">
</div>
</body>
</html>
Se puede descargar este
ejemplo y editarlo. Debe reemplazar la key incluída en
el archivo por una propia. El generador de key se puede accesar desde el siguiente enlace
API Planos key.
Si registra una key para un directorio particular, esta key
trabajará para todos los subdirectorios también.
La URL (http://apiplanos.amarillas.cl/planosapi/api/js/reqapis/Apis?)
es la ubicación de un archivo javaScript que incluye todas las funcionalidades de API.Planos
para que pueda incorporarlas en sus páginas.
El código en la página debe contener un script tag apuntando a la URL antes
mencionada.
<script language="javascript"
src="http://apiplanos.amarillas.cl/planosapi/api/js/reqapis/Apis?key=8%2BRYpfWcDBd7Rbj4inwvDypltNMOrwOd&v=1.3">
</script>
Donde:
-
key: corresponde a la clave del usuario.
-
v: corresponde a la versión de la API.
La clase que representa un plano (map) es Map.
Esta clase muestra un plano básico en la página. Se pueden
crear tantas instancias de esta clase como se quiera (una por cada
plano en la página). Cuando se crea una nueva instancia de plano en
la página, se debe especificar un nombre de elemento en la página
(usualmente un elemento div) para contener el
plano. Para mayor información consultar Map.
Controles de Navegación
API.Planos entrega funcionalidades de Zoom y Desplazamiento.
Comprende 14 niveles de Zoom y desplazamientos superior, inferior, derecha e izquierda.
Skin de Planos
API.Planos provee la elección de diferentes Skin para Planos:
3 trazados normales, 1 fotográfico y 1 híbrido.
Geocoding
Geocoding es el proceso de convertir direcciones (como "Av
Santa María 0792, Providencia") en coordenadas geográficas (como
latitud -33.429 y longitud -70.624), las cuales pueden ser usadas
para posicionarse en el Plano o colocar InfoWindows. La API
incluye un geocoder que
puede ser accesado vía HTTP o directamente dentro del
JavaScript como un panel de búsqueda.
Esta API se utiliza por medio de suscripción previa de un contrato de servicios entre el usuario
y Publiguías y es un servicio tarificado por consulta. Si Ud. desea emplear esta API
contáctenos al mail apiplanos@publiguias.cl.
Búsqueda Local y Rutas
API.Planos incluye servicios de Búsqueda
Local y de Rutas. A partir de una dirección
específica se encuentra y visualiza un punto en el plano.
Si 2 direcciones son ingresadas se encontrará y visualizará
la Ruta óptima entre esas 2 direcciones (a pie o con sentido del
tránsito).
InfoWindows
API.Planos incluye un servicio de InfoWindows, para visualizar
puntos con contenidos en el plano.
Más Información
API.Planos proporciona la funcionalidad de Más
Información de un punto específico del plano
(nombre de la calle y su altura correpondiente).
Toolbar
API.Planos proporciona a través de la Toolbar las funcionalidades de Imprimir
y de enviar el plano por e-mail.
E-mail Contextual
API.Planos proporciona la funcionalidad de envíos de e-mail contextuales, o e-mail con informaciones
referidas al punto que se desea resaltar. Se envía un link al mail del destinatario con la información y el
plano a desplegar.
Adicionalmente el contenido de la página que visualiza el destinatario puede contener
publicidad del servicio que envía o servicio que usa esta API. Si Ud. desea emplear esta funcionalidad
deberá suscribir un contrato de servicios con Publiguías, éste es tarificado en función del plazo
durante el cual usará la API. Si desea más información acerca de esta API
contáctenos al mail apiplanos@publiguias.cl.
Puntos de Interés
API.Planos proporciona la funcionalidad de desplegar Puntos de Interés de acuerdo a las necesidades del
usuario. Los puntos de interés se pueden representar como elementos Fijos o elementos Seleccionables de acuerdo a categorías
y subcategorías. Para más información revisar Categorías y Subcategorías.
|