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)