REST API Error Handling

When basic HTTP authentication fails

Sample request

HTTP

HTTP Request

GET /api/v1/some_resource HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_API_TOKEN

cURL

cURL Request

curl "https://api.example.com/api/v1/some_resource" \
  -u "username:password"

PowerShell

PowerShell Request

$username = "username"
$password = "password"
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $username, $password)))

$headers = @{
    "Authorization" = "Basic $base64AuthInfo"
}

Invoke-RestMethod -Uri "https://api.example.com/api/v1/some_resource" `
  -Method GET `
  -Headers $headers

When validations fail

Sample request

HTTP

HTTP Request

POST /api/v1/some_resource HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_API_TOKEN

cURL

cURL Request

curl -X POST "https://api.example.com/api/v1/some_resource" \
  -u "username:password"

PowerShell

PowerShell Request

$username = "username"
$password = "password"
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $username, $password)))

$headers = @{
    "Authorization" = "Basic $base64AuthInfo"
}

Invoke-RestMethod -Uri "https://api.example.com/api/v1/some_resource" `
  -Method POST `
  -Headers $headers

{
  "errors": {
    "open_till": [
      "in_past"
    ],
    "questionnaire_keys": [
      "blank",
      "invalid"
    ]
  }
}