Geração de Código de Cliente em Test & Doc APIS

54

Este novo utilitário consiste em um editor de código de cliente para as APIs das Ontologias nas principais linguagens de programação, assim só teremos que copiar o código que ele gera e inseri-lo em nossos aplicativos.

Para isso devemos acessar a API da Ontologia que queremos invocar. Neste exemplo, será “APARCAMIENTOSPUBLICOSMADRIDES”. Então vamos acessar o menu “API MANAGER” e o submenu “APIs”:

Image 002

Uma vez aqui, vamos para a guia “Minhas inscrições”:Image 005

E nós escolhemos a API que queremos testar. E clique no botão “Test & Doc”:Image 008Aqui temos informações sobre a API e as funções que ela expõe para o seu consumo. Vamos escolher a função “getAll”:Image 011

Em seguida, mostramos as informações referentes a essa função, e na parte direita aparecerá um menu suspenso chamado “Invocação para a API”, no qual escolheremos o idioma que queremos usar para invocar a função:Image 014

E isso gerará o código necessário para invocar a função. Teremos apenas que completar este código usando o token do usuário com o qual estamos logados na parte “x-sofia2-apikey”:Image 017

Criei uma página de exemplo em HTML usando JQuery, para inserir o código que nos gera o método da API, o código HTML usado para o exemplo seria:

<code>

<!DOCTYPE html>
<html>

<head>
<meta charset=”UTF-8″>
<title>Test API</title>
http://code.jquery.com/jquery-2.2.3.min.js

$(document).ready(function() {
$(“#myButton”).click(function() {

var settings = {
“async”: true,
“crossDomain”: true,
“url”: “https://sofia2.com/sib-api/api/v1/aparcamientospublicosmadrides/getAll&#8221;,
“method”: “GET”,
“headers”: {
“x-sofia2-apikey”: “********************”
}
}

$.ajax(settings).done(function (response) {
console.log(response);
var num = response.data.length;
$(“#helloWorldDiv”).html(“Request URL: https://sofia2.com/sib-api/api/v1/aparcamientospublicosmadrides/getAll
Num Result: ” + num);

});

});
});

</head>

<body>
<button id=”myButton”>Test API</button>
</br>
</br>

</body>

</html>

</code>

O resultado pode ser algo assim:

Image 028

Geração de Código de Cliente em Test & Doc APIS

Client Code Generation in Test&Doc APIs

54

This new utility consists of a client code editor for the APIs of the Ontologies in the most popular programming languages, in this way we will only have to copy the code that it generates and insert it in our applications.

For this we must access the API of the Ontology that we want to invoke. In this example, it will be “APARCAMIENTOSPUBLICOSMADRIDES “. So we will access the “API MANAGER” menu, and the “APIs” submenu:

Image 001

Once here, we go to “My Subscriptions” tab:Image 004

We choose the API that we want to test. And click on the “Test & Doc” button:Image 007

Here we have information about the API and the functions it exposes for its consumption. We are going to choose the “getAll” function:

Image 010

Next we are shown the information referring to that function, and on the right part a drop-down menu called “API Invocation” will appear, in which we will choose the language we want to use to invoke the function:

Image 013

And this will generate the piece of code needed to invoke the function. We will only have to complete this code using the logged user’s token in the “x-sofia2-apikey” part:

Image 016

I have created a sample page in HTML using JQuery, to insert the code that generates us for the API method, the HTML code used for the example would be:

<code>

<!DOCTYPE html>
<html>

<head>
<meta charset=”UTF-8″>
<title>Test API</title>
http://code.jquery.com/jquery-2.2.3.min.js

$(document).ready(function() {
$(“#myButton”).click(function() {

var settings = {
“async”: true,
“crossDomain”: true,
“url”: “https://sofia2.com/sib-api/api/v1/aparcamientospublicosmadrides/getAll&#8221;,
“method”: “GET”,
“headers”: {
“x-sofia2-apikey”: “********************”
}
}

$.ajax(settings).done(function (response) {
console.log(response);
var num = response.data.length;
$(“#helloWorldDiv”).html(“Request URL: https://sofia2.com/sib-api/api/v1/aparcamientospublicosmadrides/getAll
Num Result: ” + num);

});

});
});

</head>

<body>
<button id=”myButton”>Test API</button>
</br>
</br>

</body>

</html>

</code>

result could be something like this:

Image 028

Client Code Generation in Test&Doc APIs

Generación Código Cliente en TEst&Doc APIS

54

Esta nueva utilidad consiste en un editor de código cliente para las APIs de las Ontologías en los principales lenguajes de programación, de esta forma solo tendremos que copiar el código que genera e insertarlo en nuestras aplicaciones.

 

Para ello debemos acceder a la API de la Ontología que queremos invocar. En este ejemplo será “AparcamientoPublicosMadrides”. Así que accederemos al menú de “API MANAGER”, y al submenú “APIs”:Image 003

Una vez aquí, vamos a la pestaña de “Mis Suscripciones”:Image 006

Y elegimos la API que queremos probar. Y clickamos sobre el botón “Test & Doc”:Image 009

Aquí tenemos información de la API y de las funciones que expone para su consumo. Nosotros vamos a elegir la función “getAll”:Image 012

A continuación se nos muestra la información referente a dicha función, y en la parte derecha aparecerá un menú desplegable llamado “Invocación al API”, en el elegiremos el lenguaje que queremos usar para invocar a la función:Image 015

Y esto generará el trozo de código necesario para invocar a la función. Solo tendremos que completar dicho código usando el token del usuario con el que estamos logados en la parte del “x-sofia2-apikey”:Image 018

He creado una pagina de ejemplo en HTML usando JQuery, para insertar el código que nos genera para el método del API,  el codigo HTML utilizado para el ejemplo seria:

<code>

<!DOCTYPE html>
<html>

<head>
<meta charset=”UTF-8″>
<title>Test API</title>
http://code.jquery.com/jquery-2.2.3.min.js

$(document).ready(function() {
$(“#myButton”).click(function() {

var settings = {
“async”: true,
“crossDomain”: true,
“url”: “https://sofia2.com/sib-api/api/v1/aparcamientospublicosmadrides/getAll&#8221;,
“method”: “GET”,
“headers”: {
“x-sofia2-apikey”: “********************”
}
}

$.ajax(settings).done(function (response) {
console.log(response);
var num = response.data.length;
$(“#apiTestDiv”).html(“Request URL: https://sofia2.com/sib-api/api/v1/aparcamientospublicosmadrides/getAll
Num Result: ” + num);

});

});
});

</head>

<body>
<button id=”myButton”>Test API</button>
</br>
</br>

</body>

</html>

</code>

 

resultado sería asi:

Image 028

Generación Código Cliente en TEst&Doc APIS

Web services gestionados por el API manager de Sofia2

2-info-basica

Se ha incluido en el API manager y la consola de Sofia2 la posibilidad de gestionar web services utilizando un API rest y datos en formato JSON en lugar de XML.

Para disponibilizar de esta manera en el API manager un web service tendremos que seleccionar la casilla ‘web service’ cuando estemos creando un API nuevo. Esto cambiará el comportamiento del formulario en cierta manera, pidiendonos la URL donde encontrar la definición del web service a configurar (es decir, la dirección del fichero WSDL). Además no nos permitirá crear operaciones a mano, sino que nos dará la opción de reconocer el WSDL y generar las operaciones de forma automática:

2-info-basica

Después de crear un API, los detalles de cada operación ofrecerán un template del contenido JSON requerido por la operación.

Ciertas operaciones sobre el API no estarán disponibles, como por ejemplo editar el fichero WSDL o cambiar las operaciones. En caso de que algo cambie, se deberá provisionar otra versión del web service.

4-api-creada.jpg

Una vez provisionada, podrán hacerse consultar a través del API manager de Sofia2 usando el interfaz rest, tomando como URL base la que se ofrece bajo el nombre ‘Endpoint base’, por ejemplo: http://sofia2.com:8093/sib-api/api/ws/v1/demo-ws.

Nótese que los web service disponibilizados en el api manager tienen el prefijo ‘ws’, permitiendo saber con la url que tipo de servicio se está invocando.

Web services gestionados por el API manager de Sofia2

Data Model GSMA en Sofia2

1

Se ha disponibilizado en Sofia2 la documentación que define el soporte y funcionamiento de los Data Model GSMA en la plataforma Sofia2.

La asociación GSMA (asociación de operadores móviles) está trabajando en un IoT Big Data Harmonised Data Model. Por otro lado en la iniciativa FIWARE se han inspirado en el Data Model GSMA para crear los FIWARE Data Models.

Los Data Models GSMA (también llamados FIWARE DataModel) se definen en JSON, por lo que su representación como Ontología Sofia2 es inmediata. Para ello, haremos uso de las plantillas predefinidas en Sofia2 que soportan los anteriores modelos:

plantillas

En la documentación, que te puedes descargar aquí, o puedes consultar en versión web aquí, encontrarás cómo se definen los modelos de datos en Sofia2 para soportar los Data Models GSMA, ejemplos de uso, y un completo “Hands On” que abarca la creación de Ontologías, carga de datos mediante CRUD de Instancias, consulta de datos con la Consola BDTR y BDH, y cómo publicar Ontologías como API RESTFUL.

Data Model GSMA en Sofia2

Api .NET Updated

Sofia2 Api .Net  has been updated.

 

News in this new version are listed bellow:

  • Adapted to recently improvements added in SSAP protocol. You can see the improvements in this post SSAP Protocol Improved.
  • Bidirectional protocolo WebSockets added.
  • Test suites updated with usage samples of almost every possible query on Sofia2.
    • Rest TestSuite here.
    • WebSockets TestSuite here.
    • All tests are configured to work with Sofia2 sample data. It’s easy to run them and see how it works.

 

You can get Sofia2 Api .NET from two sources:

  1. Sofia2 Github page. https://github.com/Sofia2/dotnet-api.
  2. Developers download zone in sofia2.com  http://sofia2.com/desarrollador.html#descargas.

 

Api .NET Updated

Actualización Api .NET

Se ha actualizado el Api .NET de Sofia2

 

Las novedades introducidas son las siguientes:

  • Adaptación a las mejoras realizadas recientemente en protocolo SSAP. Puedes ver las mejoras en el siguiente POST Mejoras en protocolo SSAP.
  • Inclusión de WebSockes como protocolo bidireccional de comunicación.
  • Actualización de Test Suite con ejemplos de uso de cada posible consulta.
    • Test suite para REST aquí .
    • Test suite para WebSocket aquí.
    • Los tests están configurados para funcionar directamente contra los datos de prueba de Sofia2. Son muy fáciles de  ejecutar y ver cómo funciona.

Puedes conseguir el API .NET de Sofia2 desde dos fuentes:

 

Actualización Api .NET