JWT Authentication

This document is designed to help you securely integrate our APIs with your systems using JSON Web Tokens (JWT) to ensure all communications are protected.

What is JWT?

JWT (JSON Web Tokens) is a method for representing claims securely between two parties. In the context of FieldEx, it enables secure exchange of user credentials and permissions between your application and our APIs, ensuring that each request is authenticated and authorized efficiently.

How JWT Works in FieldEx

JWT plays a critical role in securing communications between client applications and FieldEx APIs. Here’s how it is used:

1. Token Creation: When a user logs in via your application's interface, FieldEx's authentication server validates the credentials and issues a JWT that includes user identification and role information.
   
   
2. Token Transmission: This token must be included in the HTTP Authorization header as a Bearer token for every API call made to FieldEx.
   
   
3. Token Validation: FieldEx's servers validate this token at the beginning of every API request to ensure it is valid and has not been tampered with.
   
   
4. Session Management: JWTs are configured to expire automatically, necessitating re-authentication periodically, which enhances security.

Implementing JWT in FieldEx

Follow these steps to integrate JWT authentication into your application when interacting with FieldEx APIs.

Prerequisites

• Ensure your application can handle JWT libraries available for your development platform (e.g., Auth0, jsonwebtoken for Node.js).
  
  
• Use HTTPS to secure all communications between your application and FieldEx APIs.

Generating Tokens

Login API Endpoint

• URL: https://api.fieldex.com/login
• Method: POST

‍

Request Body‍

{
  "username": "exampleuser",
  "password": "examplepassword"
}

{
    "token": "generated.jwt.token.here"
  }

httpCopy codeAuthorization: Bearer 

Title here

Description can be added here

Try now