Staging

Fr

Documentation API

Requêtes API

Visualisation graphique

Documentation API

Requêtes API

Visualisation graphique

Fr

Utilisation de l'API

Introduction

L'API Frogcast offre un moyen simple et standard d'intégrer vos données de prévision dans votre système. L'API respecte la sémantique REST, utilise JSON pour coder les objets et s'appuie le standard HTTPS.  

Authentification

Frogcast utilise une authentification simple basée sur un token (jeton). Votre token d'API comporte les mêmes privilèges que votre compte utilisateur, alors veillez à le garder secret ! Vous pouvez vous authentifier avec ce token dans l'en-tête HTTP authorization token.
Toutes les demandes d'API doivent être authentifiées et effectuées via HTTPS.

Votre token personnel :

Voici un exemple de ce qui devrait figurer dans le header de vos requêtes :

Authorization: token 

Prévisions

La récupération des prévisions avec l'API est très simple.

Dans cette section, vous trouverez des exemples prêts à l'emploi en Python, JS et CURL.

Pour récupérer les dernières prévisions, vous devez faire une requête de type GET en utilisant l'URL ci-dessous : 

https://api.frogcast.com/api/v1/forecast/

Plusieurs paramètres permettent de personnaliser la requête :
Champs obligatoires
latitude (double) : 
  • en degrés et degrés décimaux (-90° à +90°) exemple : 45.369
longitude (double) : 
  • en degrés et degrés décimaux (-180° à +180°) exemple : 8.369 
fields (str):
  • défaut : all fields (tous les champs)
  • specifiez la liste des champs séparés par un ',' par exemple: ghi_p20,ghi_p80
Champs optionnels
data_format (str):
  • split (par défaut) : format natif de l'api
  • records: version détaillée avec le nom du champ et la valeur pour chaque pas de temps
  • tight: version compacte des données qui peut être utilisée pour la visualisation des données.
precision (int):
  • défaut = 2
horizon (int):
  • défaut = 21600 ie 15 jours
time_step (int):
  • défaut = 60
  • interval : intervalle (en minutes) entre chaque série
date_time_format (str):
  • defaut : ISO 8601 UTC format, par exemple "2022-01-01T00:00:00Z"
  • time_stamp : time stamp au standard Unix
time_stamp_unit (str):
  • à spécifier uniquement si le format d'horodatage unix est demandé
  • la valeur par défaut est "s" pour obtenir l'horodatage unix en secondes, mais vous pouvez spécifier "ms" pour obtenir vos données en millisecondes

Voici un exemple in Python:

import requests
import pandas as pd

parameters = {'horizon':2880}

url = 'https://api.frogcast.com/api/v1/forecast/'

json = requests.get(url=url,params=parameters,headers=headers).json()
dataframe = pd.DataFrame(data=json['data'], columns=json['columns'], index=json['index'])

Voici un exemple en JS:

var myInit = { method: 'GET',
headers: myHeaders }; 

var myRequest = new Request(https://api.frogcast.com/api/v1/forecast/,myInit)

fetch(myRequest,myInit)

  .then(response => response.json())

Voici un exemple en CURL:

Champs météo

Category

Short name

Long name

DESCRIPTION

Toutes les variables météorologiques sont associées à des percentiles (ou quantiles) allant de 10 à 100.
Vous pouvez donc récupérer tous les quantiles de n'importe quelle variable.

Exemple pour la température : t2m,t2m_p10,t2m_p20,t2m_p30,t2m_p40,t2m_p50,t2m_p60,t2m_p70,t2m_p80,t2m_p90

Testez l'API en Live !

URL

https://api.frogcast.com/api/v1/forecast/

Headers

Autorisation token :

xxxx-xxxx-xxxx-xxxx

Afficher

Copier

Copié

PARAMèTRES

latitude:

longitude:

fields:

data_format:

precision:

horizon:

time_step:

dERNIER RésultATs

Copier

Copié

[]