Seagrass Spotter API

Welcome ¶

Please note, this API is still in development, and may change at any time.

This API is used for the Seagrass Spotter website, and the accompanying mobile app. As Seagrass Spotter is a non-profit research project, all the data is open and in the public domain. If you use the API for any project, we’d love to hear from you!

Usage ¶

To get data from the API, simply send a GET request to the relevant endpoint. For example, if you want to get all the sightings, you can GET /sightings.

Some methods require authentication. The API uses JSON Web Tokens for authentication. To obtain a token, make a request to /auth/login with your credentials, and attach the token in the headers for thoses requests.

Content-Type: application/json

{
  "username": "foo",
  "password": "bar"
}

Content-Type: application/json

{
  "access_token": "a1b2c3",
  "token_type": "bearer",
  "expires_in": 3600
}

Content-Type: application/json

{
  "message": "You need to provide the username or email, and the password",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Your details are not recognised",
  "status_code": 401
}

Content-Type: application/json

{
  "username": "foo",
  "password": "bar",
  "name": "Foo Bar",
  "email": "foo@bar.com"
}

Content-Type: application/json

{
  "access_token": "a1b2c3",
  "token_type": "bearer",
  "expires_in": 3600
}

Content-Type: application/json

{
  "message": {
    "email": [
      "The email has already been taken."
    ],
    "username": [
      "The username has already been taken."
    ]
  },
  "status_code": 400
}

Content-Type: application/json

{
  "old_password": "foo",
  "new_password": "bar"
}

Content-Type: application/json

{
  "access_token": "a1b2c3",
  "token_type": "bearer",
  "expires_in": 3600
}

Content-Type: application/json

{
  "old_password": "Your old password is incorrect."
}

Content-Type: application/json

{
  "email": "foo@foo.com"
}

Content-Type: application/json

[
  "An email with details on how to reset your password has been sent"
]

Content-Type: application/json

{
  "message": "Your email is not recognised"
}

Content-Type: application/json

{
  "0": {
    "reset_token": "ajjsgydbcvlqpe876v8bn3wu"
  },
  "1": {
    "password": "p455w0rd"
  },
  "email": "foo@foo.com"
}

Content-Type: application/json

{
  "access_token": "a1b2c3",
  "token_type": "bearer",
  "expires_in": 3600
}

Content-Type: application/json

[
  "There's no reset requested for this user."
]

Content-Type: application/json

{
  "message": "Successfully logged out"
}

Content-Type: application/json

[]

Content-Type: application/json

[]

Content-Type: application/json

[]

Content-Type: application/json

[]

Content-Type: application/json

{
  "username": "foo",
  "password": "bar"
}

Content-Type: application/json

{
  "access_token": "a1b2c3",
  "token_type": "bearer",
  "expires_in": 3600
}

Content-Type: application/json

{
  "message": "You need to provide the username or email, and the password",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Your details are not recognised",
  "status_code": 401
}