Libreria API VRChat per Dart

Blog

vrchat_dart.Un client Dart per interagire con l'API VRChat non ufficiale. Supporta tutte le chiamate REST specificate in https://github.com/vrchatapi/specification. Supporta anche lo streaming websocket per gli aggiornamenti di stato.



Disclaimer

Questa è la risposta ufficiale del team VRChat (più specificamente di Tupper) sull'utilizzo dell'API VRChat.

visualizza 3 tabella dati

L'utilizzo dell'API utilizzando applicazioni diverse dai metodi approvati (sito web, applicazione VRChat) non è ufficialmente supportato. Puoi utilizzare l'API per la tua applicazione, ma tieni a mente queste linee guida:



  • Non forniamo documentazione o supporto per l'API.
  • Non eseguire query all'API più di una volta ogni 60 secondi.
  • L'abuso dell'API può comportare la chiusura dell'account.
  • L'accesso agli endpoint API può interrompersi in qualsiasi momento, senza alcun avviso.

Come affermato, questa documentazione non è stata creata con l'aiuto del team ufficiale di VRChat. Pertanto questa documentazione non è una documentazione ufficiale dell'API VRChat e potrebbe non essere sempre aggiornata con le ultime versioni. Se riscontri che una pagina o un endpoint non è più valido, crea un problema e comunicacelo in modo che possiamo risolverlo.

Iniziare

Vedere l'esempio per iniziare in Dart.



Vedere example_flutter per informazioni su come iniziare a usare Flutter.

Contribuire

I contributi a vrchat_dart_generated dovrebbero essere fatti solo per tenerlo aggiornato con le specifiche. Clonare la specifica nella stessa cartella principale di vrchatapi-dart ed eseguire generate.sh per generare il codice.

I contributi a vrchat_dart sono i benvenuti, ma non aggiungono funzionalità che dovrebbero essere gestite dalla specifica OpenAPI.

Unisciti al server Discord per metterti in contatto con noi.

Usa questo pacchetto come libreria

Dipende da questo

Esegui questo comando:

Con dardo:

$ dart pub add vrchat_dart

Con sbattimento:

gateway API di avvio primaverile
$ flutter pub add vrchat_dart

Questo aggiungerà una riga come questa al pubspec.yaml del tuo pacchetto (ed eseguirà un dart pub implicito get):

dependencies: vrchat_dart: ^1.1.1

In alternativa, il tuo editor potrebbe supportare dart pub get o flutter pub get. Controlla i documenti per il tuo editor per saperne di più.

Importalo

Ora nel tuo codice Dart, puoi utilizzare:

import 'package:vrchat_dart/vrchat_dart.dart';

esempio/main.dart

import 'package:vrchat_dart/vrchat_dart.dart'; void main() async { final api = VrchatDart(userAgent: 'vrchat_dart_example').api; final loginResponse = await api.auth.login( username: 'example', password: 'hunter2', ); if (loginResponse.error != null) { print('authError'); print(loginResponse.error); } else if (loginResponse.requiresTwoFactorAuth) { print('requiresTwoFactorAuth'); final twoFactorResponse = await api.auth.verify2fa('123456'); if (twoFactorResponse.error == null) { print('2fa verification success'); } else { print('2fa verification failure'); print(twoFactorResponse.error); } } if (api.auth.currentUser != null) { print('logged in'); print(api.auth.currentUser?.username); } // API key fetching is automatically handled on successful authentication final friendsResponse = await api.rawApi.getFriendsApi().getFriends(); print(friendsResponse.data?.first.username); final worldsResponse = await api.rawApi.getWorldsApi().searchWorlds(); print(worldsResponse.data!.first.name); // Listen for updates api.streaming.vrcEventStream.listen(print); await api.streaming.start(); }

#flutter #dart #mobile-apps #mobile

github.com

Libreria API VRChat per Dart

Un client Dart per interagire con l'API VRChat non ufficiale. Supporta tutte le chiamate REST specificate in