Web API

[Dinoosawruss]

Is there a web API that we can use to grab data from PLAN on servers such as total players joined or average essentials balance?

Additional context

(I'm trying to make a modular plan addon for a discord bot)

[AuroraLS3]

The data that is on different tabs of the panel is available https://github.com/plan-player-analytics/Plan/blob/master/Plan/json-endpoints.md - The docs are missing some, but you can probably look at the Browser Dev console Networking tab while opening the site to find any missing ones (Remember to enable logging of XMLHTTPRequests on dev console settings)

Extension data is not available through these endpoints (I haven't serialized the object representation into json anywhere) - it needs to be accessed from the database

• https://github.com/plan-player-analytics/Plan/wiki/Database-Schema
• https://github.com/plan-player-analytics/Plan/wiki/APIv5-Query-API

[Dinoosawruss]

How would one get around the username and password with the json endpoints?

[AuroraLS3]

endpoint /auth/login?user=name&password=pass can be used to get a login cookie (Response sends Set-Cookie header).
If the cookie is not present or expires the responses will 301 (redirect) to /login?from=original address, the cookie can expire when server reboots or after the expiry time given with the cookie (Max-Age=seconds).

A proper API-key thing is probably needed at some point, but it needs web-user permissions to be redone.

[Dinoosawruss]

I seem to be getting an error every time I run it:
Exception has occurred: SSLError HTTPSConnectionPool(host='HIDDEN', port=8804): Max retries exceeded with url: /v1/auth/login?user=HIDDEN&password=HIDDEN (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: certificate has expired (_ssl.c:1108)')))

[AuroraLS3]

It sounds like you are using an out of date certificate. This can happen if you're using the self-signed cert inside Plan (which expired in 2018) or if your cert expired

[Dinoosawruss]

So its an issue with the server running Plan not what I'm doing?

[AuroraLS3]

Yep - If you have a self signed cert on the server you might need to add it to the trust store of the client you're connecting with

[Dinoosawruss]

Both my cert and the one on the server are now up-to-date and I seem to be getting a <Response 401>

[Vankka]

HTTP 401 stands for Unauthorized, check that the username & password are correct

[Dinoosawruss]

Sorry I feel like I'm being a bit of a pain

The /auth/login?... endpoint seems to return a 404

[AuroraLS3]

It sounds like you're using version older than build 545 (where cookie based login was introduced) - try updating to latest build to see if it fixes the issue https://github.com/plan-player-analytics/Plan/releases

[Dinoosawruss]

Even when the login is correct I get a user and password doesn't match error

• It happens with both the logins on the site

[AuroraLS3]

What is the full response body that you get as the error?

[Dinoosawruss]

"error": "User and Password did not match",
"status": 400,
"requestedTarget": "/auth/login"
}```