Hoy en dia las APIs juegan un papel fundamental en el ecosistema de la información, permitiendo a las aplicaciones acceder a una infinidad de servicios de una forma nunca vista antes. Athento SE acaba de liberar su API REST de Análisis de Documentos, de modo que ahora cualquier aplicación puede hacer uso del mejor servicio de análisis de documentos.
La API REST de Athento SE cuenta con Swagger, un modelo simple de representación para APIs basadas en REST. Esta representación permite tanto a las personas como a las máquinas el uso de la API de una forma sencilla.
![]() |
AthentoSE API |
Una de las mayores ventajas es su documentación interactiva: con ella es posible que un usuario experimente el uso de la API utilizando solamente su navegador web favorito.
Pero no solo llega ahí, gracias a su modelo estandarizado es posible generar código para usar la API desde prácticamente cualquier aplicación.
Autenticación
Para usar la API es necesaria la autenticación del usuario, y ésta se realiza mediante Apikeys, un token único asociado a cada usuario.
La Apikey es un método que facilita el uso y aumenta la seguridad ya que no es necesario el intercambio de credenciales del tipo usuario/contraseña.
![]() |
Obtén tu apikey |
Lo primero que haremos es conseguir nuestra Apikey. Para esto tenemos disponible un enlace "get your apikey"
![]() |
Autenticación mediante apikey |
Una vez copiada nuestra Apikey, la podemos pegar en cuadro "Apikey". ¡Ya estamos listos para usar la API!
Jugando con la API
Vamos a probar la API, consultando los metadatos de un documento.
![]() |
Probando los servicios de AthentoSE |
Pulsamos en "documents" y se despliega la vista con todas sus operaciones. En "metadata_list" encontramos una interfaz sencilla en la que rellenamos los parametros necesarios. En este ejemplo buscaremos los metadatos del primer documento.
![]() |
Respuesta del servicio |
Una vez pulsado "Try it out!", si todo fue bien, nos mostrará la respuesta: un JSON con la lista de metadatos del documento 1.
Hay muchas más operaciones disponibles en la API de AthentoSE, que son tan útiles como fáciles de usar y al alcance de un click.
Otros clientes REST
Además, podemos usar la API con Postman, nuestro cliente REST preferido, con el que podremos hacer un uso aun mas especifico de la API, y disfrutar de las demás ventajas que nos ofrece.
![]() |
Descargar documentación |
Para empezar, necesitaremos descargar la documentación. Pulsaremos en el enlace "download API docs" y veremos el código de la documentación que debemos copiar (En la mayoría de navegadores podemos pulsar Ctrl+A para seleccionar todo, y Ctrl+C para copiar). Este código es el que necesitamos para importar la API.
Y una vez copiado, en el asistente de importación pegamos el texto con la opción "Paste Raw Text" y pulsamos "Import". Con esto ya tendremos la API de AthentoSE en Postman.

No hay comentarios:
Publicar un comentario