Ya sabemos que para llamar a una API necesitamos la URL, los parámetros a introducir y la autentificación correspondiente. Por otro lado, sabemos que la respuesta de la API será un XML o un JSON que contendrá la información que hemos solicitado.

Sin embargo, hemos mencionado que hay varios aspectos que cambian de una API a otra. Por ejemplo, los parámetros son distintos según la API. Nuestra API que conjuga verbos exigirá que le introduzcamos como parámetro una palabra y que esa palabra sea un infinitivo. En cambio, una API que cuente cuántas sílabas tiene una palabra recibirá como parámetro una palabra cualquiera. De igual modo, las respuestas de estas dos APIs también serán diferentes. En el primer caso, la salida será la lista de formas conjugadas del infinitivo que introdujimos como parámetro. En la segunda, el resultado será un número que indique el número de sílabas de la palabra pasada por parámetro.

¿Y cómo sabe el usuario qué datos debe introducir para llamar a la API? ¿Cómo saber los parámetros que cada API necesita? ¿Cómo interpretar correctamente la salida? Para que los usuarios sepan cómo usar la API, el propietario de la API proporciona un pequeño manual (llamado documentación) en el que se explica cómo funciona la API, el número y el tipo de parámetros requeridos, el tipo de salida que obtendremos, cómo hacer la llamada, etc. Es decir, la documentación contiene las instrucciones para utilizar la API. Habitualmente, la documentación incluye también otra información como quién es el dueño de la API, el número de versión, las tarifas por número de consultas, etc.

Cada API tendrá su propia documentación para que los usuarios puedan probarla antes de suscribirse y sepan cómo utilizarla.

Share →