DOCS.md

SSEMMI Api Documentation v0.1.0

The documentation for the SSEMMI open API project.

• PasswordReset

  • Send email
  • Submit password
  • Verify token

• Sightings

  • Delete specific sightings
  • Contribute sightings
  • Retrieve current sightings (without token)
  • Retrieve current sightings (with token)
  • Retrieve specific sightings
  • Retrieve sightings marked as trusted

• User

  • Create/update user profile
  • Create user token
  • Delete token
  • Get user tokens
  • Retrieve current user
  • Retrieve user
  • Update password
  • Update user

PasswordReset

Send email

POST https://acartia.io/api/v1/password-resets

Parameters

Name	Type	Description
email	String	Email address to receive the password reset token.
link	String	Link to redirect user.

Submit password

PUT https://acartia.io/api/v1/password-resets/:token

Parameters

Name	Type	Description
password	String	User's new password.

Verify token

GET https://acartia.io/api/v1/password-resets/:token

Sightings

Delete specific sightings

DELETE https://acartia.io/api/v1/sightings/:id

Parameters

Name	Type	Description
access_token	String	User access_token.

Contribute sightings

POST https://acartia.io/api/v1/sightings

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve current sightings (without token)

Current sightings include any observations made in the most recent 7 days.

GET https://acartia.io/api/v1/sightings/current

Retrieve current sightings (with token)

Current sightings include any observations made in the most recent 7 days.

GET https://acartia.io/api/v1/sightings

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve specific sightings

GET https://acartia.io/api/v1/sightings/:id

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve sightings marked as trusted

GET https://acartia.io/api/v1/sightings/trusted

Parameters

Name	Type	Description
access_token	String	User access_token.

User

Create/update user profile

POST https://acartia.io/api/v1/users/:id/profile

Parameters

Name	Type	Description
access_token	String	Master access_token.
name	String	optional Contributor name.
website	String	optional Contributor website.
logoFile	String	optional Base64 of contributor logo.
id	Number	user id

Create user token

POST https://acartia.io/api/v1/users/:id/tokens

Parameters

Name	Type	Description
access_token	String	Master access_token.
name	String	optional name of token.
id	Number	user id

Delete token

DELETE https://acartia.io/api/v1/users/tokens/:id

Parameters

Name	Type	Description
access_token	String	User access_token
id	String	user token id

Get user tokens

GET https://acartia.io/api/v1/users/:id/tokens

Parameters

Name	Type	Description
id	Number	user id

Retrieve current user

GET https://acartia.io/api/v1/users/me

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve user

GET https://acartia.io/api/v1/users/:id

Update password

PUT https://acartia.io/api/v1/users/:id/password

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
password	String	User's new password.

Update user

PUT https://acartia.io/api/v1/users/:id

Parameters

Name	Type	Description
access_token	String	User access_token.
name	String	optional User's name.
picture	String	optional User's picture.
isApproved	String	optional if the user is approved by admin.