Testing a REST-API Connection

install a rest api client install a client to send test requests to the rest api recommended https //www postman com/downloads/ (free) alternative tools curl (command line), https //insomnia rest curl example curl x get "https //api example com/v1/data" \\ h "authorization bearer your token" \\ h "content type application/json" gather connection details before connecting, make sure you have the following details api reference/documentation obtain the official rest api documentation (webpage or document) request/load limitations check for any restrictions, e g , 100 requests/hour connection details endpoint address ip address and tcp port credentials (examples below) basic auth username & password identifier & secret bearer token oauth2 credentials client id & client secret, or base64 token (identifier\ secret encoded) username & password oauth scope (if non default) – defines granted privileges custom authentication may require development effort perform a request and get a 200 status code with data in return open your rest api client and create a new request set method & endpoint select get (or the method required by the api) enter the full enpoint example https //api example com/data authentication go to the related authentication tab select the required auth type (basic auth, bearer token etc ) enter your credentials or token headers (if needed) add content type application/json or any required custom headers tls validation enter the tls settings disable validate certificate in your rest api client if there are no valid tls certificate served by the rest api (self signed tls certificate = invalid) perform a test request expect an http 200 ok response verify that the response body contains the data you intend to collect troubleshooting api connection permission denied or 401 unauthorized could be caused by invalid credentials (expired token, wrong username/password) double check credentials (token, username/password, client id, client secret etc ) re issue or refresh authentication tokens if expired consult the api documentation for required parameters couldn't resolve host name check the host name if dns is used check if vpn is required to have access test network reachibility ping or curl to the endpoint rate limits exceeded (too many requests in a short time) consult the api documentation for required parameters