API documentation

[LauraWebdev]

Are there any documents or ressources for the beatsaver api? I've seen a few api urls but no documentation of it.

[Byorun]

Route::get('/songs/top/{start?}','ApiController@topDownloads');
Route::get('/songs/plays/{start?}','ApiController@topPlayed');
Route::get('/songs/new/{start?}','ApiController@newest');
Route::get('/songs/byuser/{id}/{start?}','ApiController@byUser');
Route::get('/songs/detail/{key}','ApiController@detail');
Route::get('/songs/vote/{key}/{type}/{accessToken}', 'ApiController@vote');
Route::get('/songs/search/{type}/{key}','ApiController@search');

• in general {start} is just the db offset to start from
• {id} is the the user id
• /songs/detail/{key} is a kombination of the song id and the version id "1234-44" the "-44" can be omitted in order to ge the most recent version
• /songs/vote/{key}/{type}/{accessToken} the key is the same as above exept the last part cannot be ommited, the type is 1 (up) or 0 (down) and the token is the read/write token generated from the menu
• /songs/search/{type}/{key} the type can be any of the following and the key is the searchstring

  protected function searchableKeys()
  {
      return [
          'author' => [
              'type'   => 'like',
              'fields' => ['sd.author_name'],
          ],
          'name'   => [
              'type'   => 'fulltext',
              'fields' => ['s.name'],
          ],
          'user'   => [
              'type'   => 'like',
              'fields' => ['u.name'],
          ],
          'hash'   => [
              'type'   => 'equal',
              'fields' => ['sd.hash_md5'],
          ],
          'song'   => [
              'type'   => 'fulltext',
              'fields' => ['sd.song_name', 'sd.song_sub_name', 'sd.author_name'],
          ],
          'all'    => [
              'type'   => 'mixed',
              'fields' => ['name', 'user', 'song'],
          ],
      ];
  }

[LauraWebdev]

thank you very much!

[luludotdev]

At some point I'm going to write up actual documentation for the API, I'll post it here when it's done

[lmmfranco]

Maybe leave that issue open so it is easier to find