API - Quick start

What is it?

A web interface has been created to inform user how to use API backend's calls and to try them out.

This documentation is available at api.foobot.io/apidoc/index.html for European user, for Chinese user: api-cn-north-1.foobot.io/apidoc/index.html and for rest of the world: api-us-east-1.foobot.io/apidoc/index.html.

Here's the interface: 

If user doesn't have yet, he can apply for an API key. If he already has, he can paste it in corresponding field and it'll be automatically included when trying requests.

How to test ?

Let's try Authentication request. First, click on "User login" on the right.

 

1. Enter your account's email address.

2. Click on "Model Schema" field so code will be add in text field and change "string" with your account's password.

3. Click on "Try it out!"

 

 4. Here's what you get: formatted requests including your credentials email and password (plus API Key if you have one), response body, code and header.

 

For other requests, you need to put API key and token (x-auth-token as shown uppon)

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.