GET /presence/connect

Connect to HiveMP's presence service. While this connection is established, the current account will be marked as online in the presence system. When you disconnect for any reason, the account will be marked as offline.

Request

HTTP request

GET https://presence-api.hivemp.com/v1/presence/connect

Access policies

This method can only be called with certain kinds of API keys. The API key types that are permitted to call this API are:

Additional restrictions may apply to some of the API key types listed above; refer to the method description for any additional restrictions.

Authorization

All HiveMP REST APIs require the presence of an X-API-Key header with an appropriate value, depending on the access policies outlined above.

This method requires a valid API key to be passed on request, as demonstrated in the following example:

X-API-Key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Parameters

This method does not accept any parameters.

Request body

The request body must be empty.

Response

This method will return one of the following responses:

200 Description Success
Type Not Specified
... Description An error occurred; check the value error code and message of the response
Type HiveMPSystemError

Code Snippets

curl -s \
  -H "X-API-Key: $apiKey" \
  -H "Accept: application/json" \
  -H "Content-Length: 0" \
  -X GET \
  "https://presence-api.hivemp.com/v1/presence/connect"
// At the top of your script.
using HiveMP.Api;
using HiveMP.Presence.Api;

// Inside your MonoBehaviour. Callbacks automatically happen on the main thread
// via Unity's coroutine infrastructure.
var client = new PresenceClient("<YOUR API KEY HERE>");
client.PresenceConnectGETPromise(new PresenceConnectGETRequest
    {
    },
    result =>
    {
    },
    ex =>
    {
        // HiveMP exception properties:
        // - ex.HttpStatusCode: The HTTP status code of the response
        // - ex.HiveErrorCode: The HiveMP error code
        // - ex.HiveErrorMessage: The HiveMP error message
        // - ex.HiveErrorFields: Arbitrary extra data associated with the error
    });
// Add to your namespaces.
using HiveMP.Api;
using HiveMP.Presence.Api;

// Call this inside an async method.
var client = new PresenceClient("<YOUR API KEY HERE>");
try
{
    var result = await client.PresenceConnectGETAsync(new PresenceConnectGETRequest
        {
        });
    
} catch (HiveMPException ex) { // HiveMP exception properties: // - ex.HttpStatusCode: The HTTP status code of the response // - ex.HiveErrorCode: The HiveMP error code // - ex.HiveErrorMessage: The HiveMP error message // - ex.HiveErrorFields: Arbitrary extra data associated with the error }
# Copy the text below into a Blueprints window
# inside the UE4 editor anywhere to create the node for
# this API call.
Begin Object Class=/Script/OnlineBlueprintSupport.K2Node_LatentOnlineCall Name="K2Node_LatentOnlineCall_0"
   ProxyFactoryFunctionName="PerformHiveCall"
   ProxyFactoryClass=Class'/Script/HiveMPSDK.presence_Presence_'
   ProxyClass=Class'/Script/HiveMPSDK.presence_Presence_'
End Object

Try this API

The API key to use for the request.