API Overview

Introduction

DOT Ordering APIs enables partners and vendors to integrate with DOT application via APIs.

What you can do using this API

Provides ability to:

• Search Orders

• Fetch Order Details

• Update Order Metadata

• Update Deliverable Metadata

• Update Milestone Metadata

• Fetch Controlled Vocabulary Details

Authentication

APIs are accessible through OAuth 2.0. You need to obtain an access token to make requests to the API.

Base URL

There are different Base URLs per environment and Authentication.

Rate Limiting

Work In Progress. Details will be updated soon.

Error Handling

When an error occurs, the API responds with an error message in a standard format. This includes an HTTP status code, a brief error message, and a detailed error description.

Here's an example of an error response:

• 400 Bad Request: The request was unacceptable, often due to missing a required parameter.

• 401 Unauthorized: No valid API key provided.

• 403 Forbidden: The resource you were trying to reach is absolutely forbidden for some reason.

• 404 Not Found: The requested resource couldn't be found.

• 429 Too Many Requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

• 500 Internal Server Error: An error occurred on the server while processing the request. Please try again later.

Versioning

Explain how the API versioning works and how to specify the desired API version in requests.