Integration

⭐ Matchmaking

Each matchmaker manages their own private API, separate from your organization's Edgegap API.

🍀 Simple Example

106KB

mm-conf-simple-example.json

Open

🏁 Advanced Example

🎾 Custom Lobby

🥛 Backfill Showcase

⚔️ Competitive Games

🤝 Cooperative Games

🎈 Social Games

Import API specification to Scalar API Web Client or Swagger Editor to inspect details.

Swagger Web UI: deploying your service will generate an openAPI specification and a convenient web UI. Open the URL in your browser to view and test all API endpoints, and to review payload examples.

🧭 Server Browser

Each matchmaker manages their own private API, separate from your organization's Edgegap API.

57KB

sb-openapi-closed-beta.json

Open

Swagger Web UI: deploying your service will generate an openAPI specification and a convenient web UI. Open the URL in your browser to view and test all API endpoints, and to review payload examples.

🗼 Beacons

List All Location Beacons

get

List all the active location beacons. They can be used to ping them for your matchmaking system. You cannot deploy on beacons.

Authorizations

apiKey

authorizationstringRequired

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Responses

200

Success

application/json

500

Internal Server Error

application/json

get

/v1/locations/beacons

HTTPcURLJavaScriptPython

GET /v1/locations/beacons HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "locations": [
    {
      "host": "text",
      "fqdn": "text",
      "udp_port": 1,
      "tcp_port": 1,
      "location": {
        "city": "text",
        "country": "text",
        "continent": "text",
        "administrative_division": "text",
        "timezone": "text",
        "latitude": 1,
        "longitude": 1
      }
    }
  ],
  "count": 1
}