Wized Docs

Appearance

Understanding API Headers ​

Headers are essential components of your API requests. They operate as key-value pairs, delivering crucial information about the request to the server. Headers utilize a structured format where each key signifies a specific instruction or metadata, and its corresponding value provides the necessary information.

How Headers Work ​

Headers are defined by the following components:

  • Key: A string identifier that specifies the type of metadata (e.g., Content-Type or Authorization).
  • Value: The data related to that key, which may include tokens, MIME types, or specific formatting instructions.

When you construct an API request, you add headers to ensure that the API receives all the necessary metadata, instructions, and security credentials to process your request effectively.

When to Use Headers ​

  1. Authentication:
    Many APIs require headers for authentication purposes. This typically involves including tokens, API keys, or bearer tokens to verify the user's access. For instance, the Authorization header often contains a token essential for secure access.

  2. Specifying Data Format:
    Headers can define the format of the data being sent or received. By using Content-Type headers, you can specify formats such as application/json, ensuring the API understands how to interpret the data structure.

  3. Additional Metadata:
    Headers allow for the inclusion of various types of metadata, such as preferred language (Accept-Language) or versioning (Api-Version). This capability helps the server tailor responses based on the specifics of your request.

Common Headers ​

HeaderDescription
Content-TypeSpecifies the format of the data being sent, such as application/json.
AuthorizationUsed for authentication, often including tokens (e.g., Bearer <token>).
X-Api-KeyA custom header commonly used to securely pass API keys.
AcceptIndicates the expected response format from the server, like application/json.
Accept-LanguageSpecifies the preferred language for the response.

Note

Every API has its own requirements regarding headers and their expected values. Always consult the API documentation to confirm which headers are necessary and how to structure them correctly. This practice will ensure smooth integration and data handling in your Wized application.