APIs to register lost dogs and found dogs, the data will be collected in FireStore

1. Need to install all needed libraries by using pip commands (you can see the list in requirements.txt)
2. Need to get serviceAccountKey.json from the owner
3. Run python .\app.py in the root directory
4. If everything is OK, you should be able to access http://localhost:5000/

This is the API to register a lost dog before declaring the dog actually lost.
Parameters

• customer_id line customer id
• image the image URL on s3 we get from Botnoi
• breed the dog breed
• dog_name the dog name in Thai
• dog_age the format is in {year}-{month} ex -> 1-6 age = 1 year 6 months
• dog_gender 0 | 1 , 1 is male, 0 is female
• display_name (optional) line customer display name

Curl command

curl --location --request POST 'http://localhost:5000/register' \
--header 'Content-Type: application/json' \
--data-raw '    {
        "customer_id": "xxx-xxxx-xxxx-1",
        "display_name": "Oad",
        "owner_name": "อธิการ บ่ดี",
        "image": "s3-image-url-from-botnoi",
        "dog_name": "dog",
        "dog_age": "1-6",
        "dog_gender": 1,
        "breed": "โกลเด้น"
    }'

Get method API to get all registered dog from a given customer id.
Parameters

• customer_id line customer id in query string

Return List of registered dog with following information

• breed the dog breed
• dog_id the generated dog id from Firebase
• dog_age dog age in month
• dog_gender 0 | 1, 1 is male, 0 is female
• image the dog image URL
• name the dog name

Curl command

curl --location --request GET 'http://localhost:5000/get-dogs/xxx-xxxx-xxxx-1'

The API to declare the registered dog as lost (need to do the registration before).
Parameter

• customer_id line customer id
• phone the customer phone number
• dog_id generated dog id
• location the lat, long coordination where the dog lost

Return List of match dogs from found list. It can return empty list if there is no match dog at all.

• dog_id the generated id from Firebase
• breed the dog breed in Thai
• image the dog image URL
• distance the distance between the match dogs

Curl command

curl --location --request POST 'http://localhost:5000/lost-preregister' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id": "xxx-xxxx-xxxx-1",
    "dog_id": "h9YCNMw66OUFVEYvC1En",
    "phone": "0847485152",
    "location": {
        "lat": 13.942084564850742,
        "long": 100.55160812822899
    }
}'

The API to declare a dog as lost.
Parameter

• customer_id line customer id
• phone the customer phone number
• display_name line customer display name
• image the image URL on s3 we get from Botnoi
• dog_name the dog name
• dog_age the format is in {year}-{month} ex -> 1-6 age = 1 year 6 months
• dog_gender 0 | 1, 1 is male, 0 is female
• breed the dog breed in Thai
• location the lat, long coordination where the dog lost

Return List of match dogs from found list. It can return empty list if there is no match dog at all.

• dog_id the generated id from Firebase
• breed the dog breed
• image the dog image URL
• distance the distance between the match dogs

Curl command

curl --location --request POST 'http://localhost:5000/lost-register' \
--header 'Content-Type: application/json' \
--data-raw '    {
        "customer_id": "xxx-xxxx-xxxx-2",
        "display_name": "Pao",
        "owner_name": "สมชาย เข็มกลัด",
        "phone": "0909998888",
        "image": "s3-image-url-from-botnoi",
        "dog_name": "dog1",
        "dog_gender": 0,
        "dog_age": "2-3",
        "breed": "พุดเดิ้ล",
        "location": {
            "lat": 13.942084564850742,
            "long": 100.55160812822899
        }
    }'

API to declare a found dog. Parameter

• customer_id line customer id
• display_name line customer display name
• image the image URL on s3 we get from Botnoi
• location the lat, long coordination that user found the dog

Return List of match dogs from lost list. It can return empty list if there is no match dog at all.

• dog_id the generated id from Firebase
• breed the dog breed
• image the dog image URL
• distance the distance between the match dogs

Curl command

curl --location --request POST 'http://localhost:5000/found' \
--header 'Content-Type: application/json' \
--data-raw '    {
        "customer_id": "xxx-xxxx-found-5",
        "display_name": "Godz",
        "image": "s3-image-url-from-botnoi",
        "location": {
            "lat": 13.942084564850742,
            "long": 100.55160812822899
        }
    }'

The API for testing scanning function. For example we have a lost dog, we would like to match found dogs or vice versa. Parameter

• case found or lost, if case is found it means we're looking for lost dogs
• breed the dog breed
• image the dog image
• location the dog location as lat, long coordination

Return List of match dogs. It can return empty list if there is no match dog at all.

• dog_id the generated id from Firebase
• breed the dog breed
• image the dog image URL
• distance the distance between the match dogs

Curl command

curl --location --request POST 'http://localhost:5000/test' \
--header 'Content-Type: application/json' \
--data-raw '{
    "case": "found",
    "breed": "chow chow",
    "image": "s3-image-url-from-botnoi",
    "location": {
        "lat": 13.893889357391064,
        "long": 100.56006330613269
    }
}'

1. Heroku CLI : download Heroku CLI
2. Docker : download docker

1. Login Heroku heroku login
2. Login Heroku Container heroku container:login
3. Push the container to Heroku heroku container:push web --app dog-finder01
4. Release the newly pushed image heroku container:release web --app dog-finder01
5. Now you should be able to access https://dog-finder01.herokuapp.com/ , it should say API is running