A RESTful API that returns randomly generated, custom qualitative ID's
Qual ID is a RESTful API that returns qualitative ID's. A qualitative ID is a unique signifier that is readable and understandable to humans. This serves the same purpose as any other ID, while also being much nicer to deal with and much easier to remember.
The Qual ID REST API can be accessed using the URL
https://qual-id.herokuapp.com/
The 'categories' endpoint returns a list of categories that can be composed to make patterns accepted by the 'get' endpoint. For example:
https://qual-id.herokuapp.com/categories/
which would return a JSON object containing the list of category names, e.g.
{ "data": ["animal", "food"] }An acceptable pattern for the 'get' endpoint is any list of up to 5 categories, joined by hyphens. For example,
food-animal
which would give results in the form of a food followed by an animal. In addition categories, the word random can be used, which will use a random category in it's place.
To get Qual IDs from the REST API, supply a pattern to the /get/ endpoint. For example:
https://qual-id.herokuapp.com/get/?pattern=food-animal
which would return a JSON object containing a Qual ID matching the food-animal pattern. e.g.
{ "data": ["lemon-lobster"] }In addition to the pattern parameter, the number parameter can also be used, to determine how many Qual ID's matching a given pattern will return. For example:
https://qual-id.herokuapp.com/get/?pattern=food-animal&number=3
which would return a JSON object containing a Qual ID matching the food-animal pattern. e.g.
{ "data": ["lemon-lobster", "cookie-whale", "egg-lizard"] }This repo strongly welcomes all contributions! Whether to documentation, assets, data, or code. There are standing issues to add values to existing categories, or add new categories all together. You can see the full contribution guide here.