API Development for MITE Web Portal

[mmzdouc]

Dear Community,

We are reaching out to gather your valuable input on the future development of the MITE Webportal API. The MITE development team has outlined some preliminary ideas for how the API should function (detailed below), but before finalizing the design, we want to hear from you, our community, to ensure it meets your needs and expectations.

What is an API? An API (Application Programming Interface) enables programmatic interaction with a service, such as through scripts or other applications. It allows users to access and utilize a service by adhering to its defined interface, without needing to understand its internal workings.A well-designed API should remain stable over time, making it essential to get the design right from the start. Your input will help us achieve that.

Current Situation

The current MITE Webportal (version 1.2.x) offers a basic API that allows retrieval of MITE entries in JSON format. It is accessible at: mite.bioinformatics.nl/api/.

Planned Functionality

Below are the features we envision for the API. These enhancements aim to wrap existing functionality while providing new ways to interact with the MITE database:

Search Features

1. SMILES Structure Search: Submit a SMILES structure and receive a list of MITE entries containing this structure in example substrates, products, or both.
2. SMARTS Pattern Search: Submit a SMARTS pattern and receive a list of MITE entries matching this pattern in example substrates, products, or both.
3. Protein Sequence Search (BLASTp): Submit a protein sequence in FASTA format to perform a BLASTp search, and retrieve a list of MITE entries with ≥ n% sequence similarity.
4. Custom Queries via JMESPath: Submit a JMESPath expression to retrieve a list of MITE entries that match the expression criteria.

How You Can Contribute

We want this API to be as user-friendly and functional as possible, and your feedback is crucial to achieving that goal. Do these features align with your needs? Are there additional functionalities or specific improvements you would like to see?

Please share your thoughts, suggestions, and ideas below! We look forward to your input and a vibrant discussion.