OptiMap Restful API (v1)

Download OpenAPI specification:Download

E-mail: test@test.com License: Apache 2.0 Terms of Service

OptiMap Restful API

OptiMap

Data from the Realtime Database is read using the HTTP GET request to an endpoint.

path Parameters

Username

required

string

Example: curl 'https://OptiMap.firebaseio.com/users/george/name.json'

Get user's account information

Responses

Response samples

200

Content type

application/json

[{"username": "george23@gmail.com",
"password": "abc123%^"
}
]

Data is written to the database using the HTTP PUT request.

path Parameters

Username

required

string

Example: george23@gmail.com

Input array with Username and Password into name.json

Responses

Saving Coords

path Parameters

Username required	string Example: george23@gmail.com Username of player
required	Array of objects (OptiCoords) Coordinates

Responses

Response samples

200

Content type

application/json

[{"username": "george23@gmail.com",
"coords": "Latitude: 39.9800, Longitude: -75.1600"
}
]

Data in the database is updated using the PATCH request.

path Parameters

Username

required

string

Example: curl PATCH '{"password":"abc12345^^!"}'

Username of Account

Responses

Response samples

200

Content type

application/json

[{"password": "abc12345^^!"
}
]

Deletion of user account

path Parameters

Username

required

string

Example: george23@gmail.com

Username of player