This webserver is also available directly through an API


DynaMine  |  disoMine  |  EFoldMine  |  PSPer  |  MSATools  |  ShiftCrypt

[2021-06-11] Important update:

The public repository "Demo B2B Server" has been launched containing the code to illustrate the API functionalities of Bio2Byte Tools (Jupyter Notebook is available). More details on Readme file.

API METHODS

Send request

Use below request to send your data to the API.

cURL command

cURL is a tool to transfer data from or to a server, using one of the supported protocols (HTTP, HTTPS, etc.). The command is designed to work without user interaction.


$ curl --location --request POST 'https://bio2byte.be/msatools/api/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tool_list": ["efoldmine"],
    "token": "YOURTOKEN",
    "MyProteinIdentifier1": "SEQINAALETTERS",
    "MyProteinIdentifier2": "DIFFERENTSEQINAALETTERS",
    "MyProteinIdentifierN": "SEQUENCENTH"
}'
            


Get queue status

Use below request to get information about the status of your API request.

cURL command

cURL is a tool to transfer data from or to a server, using one of the supported protocols (HTTP, HTTPS, etc.). The command is designed to work without user interaction.

$ curl --location --request GET 'https://bio2byte.be/msatools/api/queue/hash_ID'


Get results

Use below request to get your prediction results in JSON format, once they are calculated. Note that all predictions that were required to get the result you requested are included.

cURL command

cURL is a tool to transfer data from or to a server, using one of the supported protocols (HTTP, HTTPS, etc.). The command is designed to work without user interaction.

$ curl --location --request GET 'https://bio2byte.be/msatools/api/hash_ID'

API CALL EXAMPLE

Below describes an example to get data from the API via the command line using httpie ($ apt install httpie). The format of the input_file.json is described at the top of this document.

For instance, the content of the example path/input_file.json is:

{
    "tool_list": ["efoldmine"],
    "token": "YOURTOKEN",
    "Q647G9": "MAKSTILALLALVLVAHASAMRRERGRQGDSSSCERQVDRVNLKPCEQHIMQRIMGEQEQYDSYDIRSTRSSDQQQRCCDELNEMENTQRCMCEALQQIMENQCDRLQDRQMVQQFKRELMNLPQQCNFRAPQRCDLDVSGGRC",
    "P67966": "MPNWGGGKKCGVCQKAVYFAEEVQCEGSSFHKSCFLCMVCKKNLDSTTVAVHGDEIYCKSCYGKKYGPKGYGYGMGAGTLSTDKGESLGIKYEEGQSHRPTNPNASRMAQKVGGSDGCPRCGQAVYAAEKVIGAGKSWHKSCFRCAKCGKSLESTTLADKDGEIYCKGCYAKNFGPKGFGFGQGAGALIHSQ",
    "O04311": "MAQKVEAGGGAGGASWDDGVHDGVRKVHVGQGQDGVSSINVVYAKDSQDVEGGEHGKKTLLGFETFEVDADDYIVAVQVTYDNVFGQDSDIITSITFNTFKGKTSPPYGLETQKKFVLKDKNGGKLVGFHGRAGEALYALGAYFATTTTPVTPAKKLSAIGGDEGTAWDDGAYDGVKKVYVGQGQDGISAVKFEYNKGAENIVGGEHGKPTLLGFEEFEIDYPSEYITAVEGTYDKIFGSDGLIITMLRFKTNKQTSAPFGLEAGTAFELKEEGHKIVGFHGKASELLHQFGVHVMPLTN",
    "P24937": "MEDINFASLAPRHGSRPFMGNWQDIGTSNMSGGAFSWGSLWSGIKNFGSTVKNYGSKAWNSSTGQMLRDKLKEQNFQQKVVDGLASGISGVVDLANQAVQNKINSKLDPRPPVEEPPPAVETVSPEGRGEKRPRPDREETLVTQIDEPPSYEEALKQGLPTTRPIAPMATGVLGQHTPVTLDLPPPADTQQKPVLPGPTAVVVTRPSRASLRRAASGPRSLRPVASGNWQSTLNSIVGLGVQSLKRRRCF"
}

The user can access the APIs that require an input file using a Python script as described in the example below.