starpeace-project/starpeace-lumen-api-interface
The Starpeace Project Interface API
2
| Install | |
|---|---|
composer require starpeace-project/starpeace-lumen-api-interface |
|
| Latest Version: | v0.0.1 |
| PHP: | >=7.1.3 |
| License: | MIT |
| Last Updated: | Aug 29, 2018 |
| Links: | GitHub · Packagist |
Maintainer: Ron Appleton
This API acts as the new interface server for the re-build of Starpeace, it will be the communication point of the Starpeace client.
composer require starpeace-project/starpeace-lumen-api-interface
Usage
Installed routes
| Verb | Path | NamedRoute | Controller | Action | Middleware |
|---|---|---|---|---|---|
| POST | /oauth/token | \Laravel\Passport\Http\Controllers\AccessTokenController | issueToken | - | |
| GET | /oauth/tokens | \Laravel\Passport\Http\Controllers\AuthorizedAccessTokenController | forUser | auth | |
| DELETE | /oauth/tokens/{token_id} | \Laravel\Passport\Http\Controllers\AuthorizedAccessTokenController | destroy | auth | |
| POST | /oauth/token/refresh | \Laravel\Passport\Http\Controllers\TransientTokenController | refresh | auth | |
| GET | /oauth/clients | \Laravel\Passport\Http\Controllers\ClientController | forUser | auth | |
| POST | /oauth/clients | \Laravel\Passport\Http\Controllers\ClientController | store | auth | |
| PUT | /oauth/clients/{client_id} | \Laravel\Passport\Http\Controllers\ClientController | update | auth | |
| DELETE | /oauth/clients/{client_id} | \Laravel\Passport\Http\Controllers\ClientController | destroy | auth | |
| GET | /oauth/scopes | \Laravel\Passport\Http\Controllers\ScopeController | all | auth | |
| GET | /oauth/personal-access-tokens | \Laravel\Passport\Http\Controllers\PersonalAccessTokenController | forUser | auth | |
| POST | /oauth/personal-access-tokens | \Laravel\Passport\Http\Controllers\PersonalAccessTokenController | store | auth | |
| DELETE | /oauth/personal-access-tokens/{token_id} | \Laravel\Passport\Http\Controllers\PersonalAccessTokenController | destroy | auth |
API CALLS
The purpose of this API is obviously the calls we can make and the data we can obtain. Note: All data in the examples below are example data.
Initial Calls
The following calls are those currently available
/galaxies/getTypes
/galaxies/getTypes
This will return a json list of available galaxy types:
{
"data": [
{
"id": 1,
"name": "free",
"display_name": "Free",
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 2,
"name": "subscriber",
"display_name": "Subscriber",
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 3,
"name": "private",
"display_name": "Private",
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 4,
"name": "sponsored",
"display_name": "Sponsored",
"updated_at": "2018-08-22 22:40:50"
}
]
}
/galaxies/getGalaxies
/galaxies/getGalaxies
This will return a full list of the galaxy types including the worlds within
{
"data": [
{
"galaxy_id": 1,
"galaxy_type": "free",
"name": "Milky Way",
"updated_at": "2018-08-22 22:08:50",
"worlds": [
{
"id": 2,
"map_id": 2,
"display_name": "Winfield",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 11,
"map_id": 8,
"display_name": "Samir",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 13,
"map_id": 1,
"display_name": "Dixie",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 15,
"map_id": 4,
"display_name": "Hettie",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
}
]
},
{
"galaxy_id": 2,
"galaxy_type": "subscriber",
"name": "Andromeda",
"updated_at": "2018-08-22 22:08:50",
"worlds": [
{
"id": 7,
"map_id": 9,
"display_name": "Hailee",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 8,
"map_id": 9,
"display_name": "Kellen",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
}
]
},
{
"galaxy_id": 3,
"galaxy_type": "private",
"name": "Black Eye Galaxy",
"updated_at": "2018-08-22 22:08:50",
"worlds": [
{
"id": 1,
"map_id": 1,
"display_name": "Edward",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 6,
"map_id": 8,
"display_name": "Ova",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 14,
"map_id": 2,
"display_name": "Cayla",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 17,
"map_id": 3,
"display_name": "Brycen",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 18,
"map_id": 3,
"display_name": "Burnice",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 19,
"map_id": 5,
"display_name": "Laury",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 20,
"map_id": 10,
"display_name": "Arvilla",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
}
]
},
{
"galaxy_id": 4,
"galaxy_type": "sponsored",
"name": "Virgo Stellar Stream",
"updated_at": "2018-08-22 22:08:50",
"worlds": [
{
"id": 3,
"map_id": 8,
"display_name": "Amelie",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 4,
"map_id": 3,
"display_name": "Lelia",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 5,
"map_id": 10,
"display_name": "Winona",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 9,
"map_id": 8,
"display_name": "Roger",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 10,
"map_id": 10,
"display_name": "Mike",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 12,
"map_id": 4,
"display_name": "Turner",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 16,
"map_id": 3,
"display_name": "Angus",
"year": 2000,
"updated_at": "2018-08-22 22:40:50"
}
]
}
]
}
/galaxies/getGalaxy/[n]
/galaxies/getGalaxy/1
This will return the worlds in the given galaxy [n]
{
"data": [
{
"id": 2,
"map_id": 2,
"display_name": "Winfield",
"year": 2000,
"investors": 9,
"online": 0,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 11,
"map_id": 8,
"display_name": "Samir",
"year": 2000,
"investors": 8,
"online": 0,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 13,
"map_id": 1,
"display_name": "Dixie",
"year": 2000,
"investors": 4,
"online": 0,
"updated_at": "2018-08-22 22:40:50"
},
{
"id": 15,
"map_id": 4,
"display_name": "Hettie",
"year": 2000,
"investors": 8,
"online": 0,
"updated_at": "2018-08-22 22:40:50"
}
]
}
This return includes details of how many tycoons are investors on each world along with how many investors were online within the last ten minutes.
Discover the release history by heading on over to the releases page.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Unless stated otherwise all works are:
and licensed under:
Related Packages
habil/microservice-remote-models
A Lumen package to provide a familiar model paradigm for distributed data.
20
0