You’ll probably know by now that in order to call an API you will need its URL, some parameters to enter and its authorisation code. Likewise, you’ll know that your request for the API will either be a XML or JSON which will contain the information you want to see.
However, as we mentioned before, there are various factors that make one API different from another. For example, the parameters tend to vary between each API. Our verb conjugator API requires you to introduce a single word as a parameter, provided that this word is an infinitive verb. Alternatively, an API that counts the number of syllables in a word will accept any word as a parameter. In the same way, the outcomes of these two APIs will also be different. In the case of the first API, the end result will be the list of conjugated forms of the infinitive verb previously introduced as a parameter. In the second, the outcome will be a number indicating the quantity of syllables of the word entered as a parameter.
And how does the user know which details to introduce in order to call an API? How do you know which parameters each API needs? How do you figure out what the results mean? To help our users learn the technique behind the APIs, the creator of each API has provided a basic manual (documentation) in which they explain how the API works, the number and type of parameters required, the type of result you’ll obtain, how to call the API, etc. That is, the documentation contains the instructions for using the API. Normally, the documentation will also include other information, such as who the owner of the API is, the version, the tarif listing the number of consults, etc.
Each API will have its own documentation to help our users test the API before subscribing and understand how to use it.