Organization API: Org Game Network

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

GET /api/v1/orgs/{org_slug}/network/entitlements

Lists the purchases the network delivers, in the order they last changed. They are the organization's services of its custom_standalone products, ordered by updated_at, then service_id. Each has the customer, the product, its status and billing_cycle, the config the customer ordered with, its dates and the delivery you last recorded. next_cursor reads the next page and is null on the last one. Recording a delivery, a payment, a renewal or a cancellation moves a purchase to the end. Needs an organization API key with network:read. 422 for a time, cursor or limit that is wrong.

POST /api/v1/orgs/{org_slug}/network/entitlements/{service_id}/delivery

Records how a purchase's delivery went. The status is delivered, waiting or failed, with an optional detail. It is kept in the purchase's config.delivery as {"status", "at", "detail"}, which the customer's account returns with the service, replaces the delivery recorded before and is in the organization's audit log. Answers {"entitlement"} as the list shows it. Needs an organization API key with network:write. 404 for a purchase that is not one of the organization's custom_standalone services.

application/json (required)

GET /api/v1/orgs/{org_slug}/network/leaderboards

The leaderboards as the backend last pushed them, each board's entries in rank order. Needs no auth. Coritan, browsers and caches each keep an answer for up to 15 seconds, so a push can take up to a minute to show. Before the first push boards is empty and updated_at is null; stale is true when the last push is more than five minutes old. 404 for an unknown organization.

PUT /api/v1/orgs/{org_slug}/network/leaderboards

Replaces the leaderboards: up to 30 boards of up to 100 entries each. Push them every five to fifteen minutes. Needs an organization API key with network:write. Answers {"kind": "leaderboards", "updated_at"}; 422 names the field that is wrong, 413 past 2 MB.

application/json (required)

GET /api/v1/orgs/{org_slug}/network/market

The market as the backend last pushed it. It holds items, the categories they use in the order they first appear, and currency_symbol. Needs no auth. Coritan, browsers and caches each keep an answer for up to 15 seconds, so a push can take up to a minute to show. Before the first push items is empty and updated_at is null; stale is true when the last push is more than five minutes old. 404 for an unknown organization.

PUT /api/v1/orgs/{org_slug}/network/market

Replaces the market. It holds every item with its sell and buy prices, its change over 24 hours and how many changed hands. An item left out leaves the market. Push it every one to five minutes. Needs an organization API key with network:write. Answers {"kind": "market", "updated_at"}; 422 for more than 1,000 items, two items with one key or any other field that is wrong, which the answer names; 413 past 2 MB.

application/json (required)

POST /api/v1/orgs/{org_slug}/network/players

Records players the network has seen, so the website can look a name up. Each player is kept once by UUID, with the name and edition of their latest sighting; a sighting older than the one kept changes nothing. Send the players seen since the last push every 30 to 60 seconds, up to 1,000 a push. Needs an organization API key with network:write. Answers {"saved"}, the number of distinct players; 422 names the field that is wrong.

application/json (required)

GET /api/v1/orgs/{org_slug}/network/players/lookup

Whether the network has seen a player with this name. Answers {"found": true, "player": {"name", "uuid", "edition", "last_seen"}} for the one seen most recently, or {"found": false}. Needs no auth. Coritan, browsers and caches each keep an answer for up to 15 seconds, so a new sighting can take up to a minute to show. 422 when the name breaks the pattern; 404 for an unknown organization.

GET /api/v1/orgs/{org_slug}/network/status

The network's status as the backend last pushed it, with the addresses players join on. Needs no auth. Coritan, browsers and caches each keep an answer for up to 15 seconds, so a push can take up to a minute to show. Before the first push the values are null, regions is empty and updated_at is null. stale is true when the last push is more than five minutes old, or there has been none. 404 for an unknown organization.

PUT /api/v1/orgs/{org_slug}/network/status

Replaces the network's status. It says whether the network is online, how many play, the season and players per region. Push it every 15 to 60 seconds; the website calls the status stale when the last push is more than five minutes old. Needs an organization API key with network:write. Answers {"kind": "status", "updated_at"}; 422 names the field that is wrong, 413 past 2 MB.

application/json (required)