Authentification

Pour être en mesure d'utiliser les services, vous devez obligatoirement vous authentifier à chaque utilisation de ceux-ci.

L'authentification utilise la méthode HTTP Basic. Il vous suffit de passer votre nom d'utilisateur et votre clé d'API pour avoir accès aux différents services.

La clé d'API est une clé unique qui vous a été remise lors de la création de votre compte. Elle a l'avantage d'être complètement indépendante de votre mot de passe et peut être régénérée sans qu'on doive modifier les autres informations de votre compte.

Exemple

get https://[username]:[api_key]@www.pretnumerique.ca/v1

Réponse échouée

Code Description
401 Accès refusé. Il y a un problème avec votre nom d'utilisateur ou votre clé d'API. 
{
  "errors": ["access_refused"]
}

<loan>
  <errors>
    <error>access_refused</error>
  </errors>
</loan>
Accès refusé

Pagination

Requête

Vous pouvez contrôler la page sélectionnée en passant le paramètre "page".

Exemple

get https://www.pretnumerique.ca/v1/resources.json?page=1

Réponse

Les services Web paginés incluent toujours 4 variables dans l'en-tête de la réponse.

  • Nombre d'éléments disponibles
  • Nombre de pages total
  • Nombre d'éléments par page
  • Numéro de la page courante

Dans le cas où la page serait hors limite, une erreur 404 sera retournée.