Skip to content

README.md

Latest commit

 

History

History
75 lines (49 loc) · 2.18 KB

README.md

File metadata and controls

75 lines (49 loc) · 2.18 KB
Raw

🌦️ AClimate V3 API

🏷️ Version & Tags

GitHub release (latest by date)

📌 Introduction

AClimate V3 API provides RESTful endpoints to access climate data, forecasts, and administrative information for the AClimate platform. Built with FastAPI, it integrates authentication and authorization with Keycloak for secure access.

This API exposes data models (countries, locations, admin levels, climate data) through a consistent and clean interface.

Features

  • 🚀 FastAPI-based high-performance REST API
  • 🔐 Keycloak integration for authentication and role-based authorization
  • 🌐 Simplified data access: climate historical, monthly, climatology, locations, admin levels
  • 🧩 Modular router structure
  • 📚 Auto-generated Swagger & ReDoc documentation

✅ Requirements

  • Python > 3.10
  • Keycloak running and configured for user management and token issuance
  • Relational database (PostgreSQL)
  • Dependencies: FastAPI, Pydantic, SQLAlchemy, psycopg2, python-dotenv, uvicorn, python-keycloak, jose

🔐 Authentication & Authorization

The API uses Keycloak for OAuth2 password grant authentication.
To access secured endpoints:

1️⃣ Start Keycloak and configure a realm, client, and users.
2️⃣ Obtain a JWT token from Keycloak.
3️⃣ Include the token in the Authorization header of your API requests.

🔐 Authentication Example

Include your Keycloak token in the Authorization header:

Authorization: Bearer <access_token>

🚀 Installation Steps

Clone the repository and install dependencies:

git clone https://github.com/CIAT-DAPA/aclimate_v3_api.git
cd src
pip install -r requirements.txt

🌱 Set the Environment Variables

Set up the environment variables in a .env file:

DATABASE_URL=postgresql://username:password@localhost:5432/database
KEYCLOAK_URL=http://localhost:8080
KEYCLOAK_REALM=<realm>
KEYCLOAK_CLIENT_ID=<client-id>
KEYCLOAK_CLIENT_SECRET=<client-secret>

🚀 Run the API

uvicorn main:app --reload