DEV Community

SkyFi Support
SkyFi Support

Posted on

๐—›๐—ผ๐˜„ ๐—ฐ๐—ฎ๐—ป ๐—œ ๐˜๐—ฒ๐˜€๐˜ ๐—ถ๐—ณ ๐˜๐—ต๐—ฒ ๐—ฆ๐—ธ๐˜†๐—™๐—ถ ๐—”๐—ฃ๐—œ ๐˜€๐—ฒ๐—ฟ๐˜ƒ๐—ถ๐—ฐ๐—ฒ ๐—ถ๐˜€ ๐—ฟ๐—ฒ๐—ฎ๐—ฐ๐—ต๐—ฎ๐—ฏ๐—น๐—ฒ ๐—ผ๐—ฟ ๐—ต๐—ฒ๐—ฎ๐—น๐˜๐—ต๐˜†?

The SkyFi API provides simple endpoints to verify that the service is up and responding:

๐—ฃ๐—ถ๐—ป๐—ด ๐—˜๐—ป๐—ฑ๐—ฝ๐—ผ๐—ถ๐—ป๐˜: GET /ping โ€“ This requires no parameters except the API key in the header. If the service is running, it returns a JSON with a message (e.g., "message": "pong" or a similar friendly response).

๐—›๐—ฒ๐—ฎ๐—น๐˜๐—ต ๐—–๐—ต๐—ฒ๐—ฐ๐—ธ ๐—˜๐—ป๐—ฑ๐—ฝ๐—ผ๐—ถ๐—ป๐˜: GET /health_check โ€“ This returns a status object (e.g., {"status": "healthy"}) indicating the overall health of the API service.

Using these endpoints in a test can quickly confirm connectivity and authentication. For example, you could run:

If you receive the expected response (HTTP 200 OK with a message), then your API key is valid and the service is reachable. If you get an error (401 Unauthorized or no response), you may need to check your API key or network connection.

Top comments (0)