Link Search Menu Expand Document (external link)

API - Auth Service

Organization

POST /organization/create

Parametri body:

  • organizationName
    Tipo: Stringa
    Obbligatorio: sì
    Descrizione Nome univoco dell’Organization da creare.
  • name
    Tipo: Stringa
    Obbligatorio: sì
    Nome del primo titolare di un account Farmer collegato all’Organization da creare.
  • surname
    Tipo: Stringa
    Obbligatorio: sì
    Cognome del primo titolare di un account Farmer collegato all’Organization da creare.
  • mail
    Tipo: Stringa
    Obbligatorio: sì
    Mail del primo titolare di un account Farmer collegato all’Organization da creare.
  • birthdate
    Tipo: Data
    Formato: “1997-12-31T00:00:00.000+00:00”
    Obbligatorio: sì
    Mail del primo titolare di un account Farmer collegato all’Organization da creare.
  • password
    Tipo: Stringa
    Obbligatorio: sì
    Password del primo titolare di un account Farmer collegato all’Organization da creare.

Risultato atteso: 201

  • token
    Farmer token ottenuto autenticandosi con il nuovo account Farmer creato.

GET /organization/info

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi con un account Farmer.

Risultato atteso: 200

  • name
    Nome dell’Organization collegata all’account autenticato.

Farmer

POST /farmer/register

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi con un account Farmer.

Parametri body:

  • name
    Tipo: Stringa
    Obbligatorio: sì
    Nome del titolare del nuovo account Farmer collegato all’Organization contenuta nel Farmer token.
  • surname
    Tipo: Stringa
    Obbligatorio: sì
    Cognome del titolare del nuovo account Farmer collegato all’Organization contenuta nel Farmer token.
  • mail
    Tipo: Stringa
    Obbligatorio: sì
    Mail del titolare del nuovo account Farmer collegato all’Organization contenuta nel Farmer token.
  • birthdate
    Tipo: Data
    Formato: “1997-12-31T00:00:00.000+00:00”
    Obbligatorio: sì
    Data di nascita del titolare del nuovo account Farmer collegato all’Organization contenuta nel Farmer token.
  • password
    Tipo: Stringa
    Obbligatorio: sì
    Password del titolare del nuovo account Farmer collegato all’Organization contenuta nel Farmer token.

Risultato atteso: 201

  • id
    Id univoco associato al nuovo account Farmer creato.

GET /farmer/login

Parametri query:

  • mail
    Tipo: Stringa
    Obbligatorio: sì
    Mail associata al Farmer account al quale si intende autenticarsi.
  • password
    Tipo: Stringa
    Obbligatorio: sì
    Password associata al Farmer account al quale si intende autenticarsi.

Risultato atteso: 200

  • token
    Farmer token ottenuto autenticandosi al Farmer account specificato.

GET /farmer/list

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi con un account Farmer.

Risultato atteso: 200

  • farmers
    Lista di Farmer associati all’Organization contenuta nel Farmer token.

GET /farmer/info

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi al Farmer account specificato.

Parametri query:

  • id
    Tipo: Stringa
    Obbligatorio: sì
    Id del Farmer account della qualesi desidera ottenere le info.

Risultato atteso: 200

  • name
    Nome del titolare del Farmer account richiesto.
  • surname
    Cognome del titolare del Farmer account richiesto.
  • mail
    Mail del titolare del Farmer account richiesto.
  • birthdate
    Data di nascita del titolare del Farmer account richiesto.

Greenhouse

POST /greenhouse/create

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi al Farmer account specificato.

Parametri body:

  • name
    Tipo: Stringa
    Obbligatorio: sì
    Nome, univoco all’interno dell’Organization specificata nel Farmer token, della nuova Greenhouse da creare.

Risultato atteso: 201

  • id
    Id della Greenhouse creata.

GET /greenhouse/list

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi al Farmer account specificato.

Risultato atteso: 200

  • greenhouses
    Lista di Greenhouse associate all’Organization contenuta nel Farmer token.

Environment

POST /environment/create

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi al Farmer account specificato.

Parametri body:

  • name
    Tipo: Stringa
    Obbligatorio: sì
    Nome, univoco all’interno della Greenhouse, del nuovo Environment che si intende creare.
  • password
    Tipo: Stringa
    Obbligatorio: sì
    Password del nuovo Environment che si intende creare.
  • greenhouseId
    Tipo: Stringa
    Obbligatorio: sì
    Id della Greenhouse associata a questo Environment.

Risultato atteso: 201

  • id
    Id del nuovo Environment creato.

GET /environment/list

Header richiesti:

  • token
    Farmer token ottenuto autenticandosi al Farmer account specificato.

Parametri query:

  • id
    Tipo: Stringa
    Obbligatorio: sì
    Id della Greenhouse della quale si vuole ottenere la lista di Environment associati.

Risultato atteso: 200

  • environments
    Lista di Environment associati alla Greenhouse specificata.

Agent

GET /agent/login

Parametri query:

  • organizationName
    Tipo: Stringa
    Obbligatorio: sì
    Nome dell’Organization che contiene la Greenhouse la quale contiene l’Environment alla quale ci si intende autenticare.
  • greenhouseName
    Tipo: Stringa
    Obbligatorio: sì
    Nome della Greenhouse che contiene l’Environment alla quale ci si intende autenticare.
  • environmentName
    Tipo: Stringa
    Obbligatorio: sì
    Nome dell’Environment alla quale ci si intende autenticare.
  • environmentPassword
    Tipo: Stringa
    Obbligatorio: sì
    Password dell’Environment alla quale ci si intende autenticare.

Risultato atteso: 200

  • token
    Agent token ottenuto autenticandosi ad un Environment.