If you plan on wanting access to multiple servers – eg: you're creating a viewer script service – then you will want to create an application. When you create an API application, this allows users to visit your website and grant your application the ability to perform actions on their server on their behalf. This is the recommended way to use the API.
Click on "API Applications" under your GameVox username on the left hand side
Give your GameVox Application a name
Enter the Website where users can find or use your application
Add a description to your application, this is just for our internal use and will not be displayed to users
Give the URL that the page will send the user back to once they've authorized your program
Information To Note
Once you've created your GameVox API Application there are some things that you'll want to make note of that you'll need in future steps. You'll want to make note of the "Client ID" and the "Client Secret" as these will be used to authenticate your application.
Option 2: Use a server API Token
Alternatively, you may generate an API Token under "Manage Server" for a given server which will grant full access to the server.
This token may be used if you want to explore the API without creating an application or if you want to quickly integrate your single server with your website. A server can only have one API token at a time and is not recommended that you give this token out.
If you do not pass the Authorization header or the access_token query parameter, the following error will be returned with a 400 (Bad Request) response code
message: "The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter."
If the access token you specified is invalid or revoked, a 401(Unauthorized) response code will be returned
message: "The resource owner or authorization server denied the request."
Using .NET 4.5 and lower:
If you are getting a .NET exception SocketException 'An existing connection was forcibly closed by the remote host' this means that you'll need to set the security protocol for the RESTful calls. You can do this by: System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
You must use the TLS1.2 SSL to communicate with our API.