Request Formatlink

To make a request, combine the HTTP verb/method (GET, POST, PATCH or DELETE), the URL to the API service, the URI to a resource and the HTTP request headers.

The HTTP methods are used as follows:

• GET to get or list a resource.
• POST to create a resource.
• PATCH to update a resource.
• DELETE to delete a resource.

Successful requests will return a 200 OK status.

Request Headerslink

Every API request must include these headers:

Acceptlink

This header indicates the response format, which is required for operations with a response body. The syntax is:

Accept: application/json

Authorizationlink

This header is required in order to authenticate over the API. It enables you to perform actions on behalf and with the approval of the resource owner, and follows the Bearer authentication scheme:

Authorization: Bearer <Access Token>

Content-Typelink

This header indicates the request format, which is required for operations with a request body (POST, PATCH). The syntax is:

Content-Type: application/json

User-Agentlink

Include this header with the name of your application and a link to it or your email address, so we can get in touch with you:

User-Agent: Custom App Name (https://example.com/contact)

Or:

User-Agent: Custom App Name (contact@example.com)

Content Typeslink

Common Mistakeslink

Missing Content-Typelink

# Wrong - missing Content-Type for POST or PATCH
curl -X POST "https://api.infraspeak.com/v3/failures" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{"description": "Test"}'

# Correct
curl -X POST "https://api.infraspeak.com/v3/failures" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description": "Test"}'

Invalid JSONlink

# Wrong - trailing comma
{"description": "Test",}

# Correct
{"description": "Test"}

Wrong HTTP Methodlink

# Wrong - using POST or PUT to update
curl -X POST "https://api.infraspeak.com/v3/failures/12345" ...

# Correct - use PATCH to update
curl -X PATCH "https://api.infraspeak.com/v3/failures/12345" ...