Authentication is simple, append the private key that can be found in your dashboard to the API end point like in the example to the right. That's it, your request is now authenticated and logged in your api call log.
The WebCargo API uses standard HTTP response codes to communicate the result of an API call. Below is a list of the possible codes that could be returned and how they should be interpreted.
The command was processed successfully.
Well formatted request however some technical issue is preventing the serving of the request, e.g. an unresponsive WHOIS server.
The end-point you have sent the request to is not valid. For example you may have sent the request to /idontexist rather than /whois.
The HTTP request method used is not compatible with the selected end-point. This can occur when using POST rather than GET, for example.
The request has been incorrectly constructed. This can occur when omitting required parameters or providing them in the wrong type.
The request was not authorised. This can occur when using an incorrect key, if the server IP is not on the accounts white list, if the account is banned, or the account email address has not been verified.
The request was refused due to a billing issue with the associated account. Please check you have sufficient funding associated with your account and no outstanding invoices.
Internal Server Error
The client did everything correctly, but we've had an internal issue.