API RCPHOTOS.FR

Ceci est la page d'accueil.

Gestion des utilisateurs

Pour se créer un compte et utiliser l'api, il faut se rendre sur la page ci-dessous :

https://api.dev.rcphotos.fr/users

Authentification

Type de requête : POST

https://api.dev.rcphotos.fr/api/login
Clé Description
email Adresse email de l'utilisateur (obligatoire)
password Mot de passe de l'utilisateur (obligatoire)
Valeurs renvoyées :
Clé Description
user
id ID de l'utilisateur
name Nom de l'utilisateur
email Adresse email de l'utilisateur
email_verified_at Date de vérification de l'adresse email de l'utilisateur
created_at Date de création de l'utilisateur
updated_at Date de la dernière mise à jour de l'utilisateur
-
access_token Token d'accès à utiliser pour les requêtes authentifiées
token_type Type de token (généralement "Bearer")

Liste des articles

Type de requête : GET

https://api.dev.rcphotos.fr/api/articles
Valeurs renvoyées :
Clé Description
id Identifiant unique de l'article
titre Titre de l'article
description Description de l'article
published_at Date de publication de l'article
vignette Nom de l'image de vignette de l'article
status Statut de l'article
created_at Date de création de l'article
updated_at Date de la dernière mise à jour de l'article
rubrique
id Identifiant unique de la rubrique
titre Titre de la rubrique
image Nom de l'image associéeà la rubrique
description Description de la rubrique
titre_page titre de la page associé à la rubrique
created_at Date de création de la rubrique
updated_at Date de mise à jour de la rubrique
images
id Identifiant unique de l'image
comments Commentaires de l'image
article_id ID de l'article associé à l'image
url Nom de l'image
ordre Ordre de l'image
created_at Date de création de la rubrique
updated_at Date de mise à jour de la rubrique

Détail d'un article

Type de requête : GET

https://api.dev.rcphotos.fr/api/articles/408
Valeurs renvoyées :
Clé Description
id Identifiant unique de l'article
titre Titre de l'article
description Description de l'article
published_at Date de publication de l'article
vignette Nom de l'image de vignette de l'article
status Statut de l'article
created_at Date de création de l'article
updated_at Date de la dernière mise à jour de l'article
rubrique
id Identifiant unique de la rubrique
titre Titre de la rubrique
image Nom de l'image associéeà la rubrique
description Description de la rubrique
titre_page titre de la page associé à la rubrique
created_at Date de création de la rubrique
updated_at Date de mise à jour de la rubrique
images
id Identifiant unique de l'image
comments Commentaires de l'image
article_id ID de l'article associé à l'image
url Nom de l'image
ordre Ordre de l'image
created_at Date de création de la rubrique
updated_at Date de mise à jour de la rubrique

Ajout d'un article

Type de requête : POST

https://api.dev.rcphotos.fr/api/articles
Valeurs à fournir
Clé Type Description
titre string Titre de l'article (obligatoire)
description string Description de l'article (obligatoire)
published_at datetime Date de publication de l'article (obligatoire) au format aaa-mm-jj hh-mm-ss
rubrique_id integer ID de la rubrique à laquelle l'article appartient (obligatoire)
status integer Statut de l'article (obligatoire)

Mise à jour d'un article

Cette API permet de mettre à jour les données d'un article et en plus de modifier les images associées si elles sont fournies.

Type de requête : PUT

https://api.dev.rcphotos.fr/api/articles/408
Valeurs à fournir
Clé Type Description
titre string Titre de l'article (obligatoire)
description string Description de l'article (obligatoire)
published_at datetime Date de publication de l'article (obligatoire) au format aaa-mm-jj hh-mm-ss
rubrique_id integer ID de la rubrique à laquelle l'article appartient (obligatoire)
status integer Statut de l'article (obligatoire)
images
url string Nom de l'image (obligatoire)
ordre integer Ordre de l'image
comments string Commentaire de l'image
vignette boolean Indique si l'image est une vignette

Suppression d'un article

Cette API permet de supprimer les données d'un article.

Type de requête : DELETE

https://api.dev.rcphotos.fr/api/articles/408
Valeurs à fournir
Clé Type Description
id integer Id de l'article à supprimer (obligatoire)
Valeurs renvoyées
Clé Type Description
message string Réponse de l'API

Liste des rubriques

Cette API permet de récupérer la liste des rubriques.

Type de requête : GET

https://api.dev.rcphotos.fr/api/rubriques
Valeurs renvoyées
Clé Type Description
rubriques
id integer Identifiant unique de la rubrique
titre string Titre de la rubrique
description string Description de la rubrique
image string Nom de l'image de la rubrique
titre_page string Titre de la page de la rubrique
created_at datetime Date de création de la rubrique
updated_at datetime Date de dernière mise à jour de la rubrique
articles
id integer Identifiant unique de l'article
titre string Titre de l'article
description text Description de l'article
published_at datetime Date de publication de l'article
created_at datetime Date de création de l'article
updated_at datetime Date de dernière mise à jour de l'article
rubrique_id integer Identifiant de la rubrique à laquelle l'article appartient
status string Statut de l'article (brouillon, publié, archivé)
vignette string Nom de la vignette de l'article

Détail d'une rubrique

Cette API permet de récupérer les détails d'une rubrique existante.

Type de requête : GET

https://api.dev.rcphotos.fr/api/rubriques/1
Valeurs renvoyées
Clé Type Description
id integer Identifiant unique de la rubrique
titre string Titre de la rubrique
description string Description de la rubrique
image string Nom de l'image de la rubrique
titrePage string Titre de la page de la rubrique
created_at datetime Date de création de la rubrique
updated_at datetime Date de dernière mise à jour de la rubrique
articles

Création d'une rubrique

Cette API permet de créer une nouvelle rubrique.

Type de requête : POST

https://api.dev.rcphotos.fr/api/rubriques
Valeurs à fournir
Clé Type Description
titre string Titre de la rubrique (obligatoire)
description string Description de la rubrique
image string Nom de l'image de la rubrique
titre_page string Titre de la page de la rubrique

Modification d'une rubrique

Cette API permet de modifier une rubrique existante.

Type de requête : PUT

https://api.dev.rcphotos.fr/api/rubriques/1
Valeurs à fournir
Clé Type Description
titre string Nouveau titre de la rubrique (obligatoire)
description string Nouvelle description de la rubrique
image string Nouveau nom de l'image de la rubrique
titre_page string Nouveau titre de la page de la rubrique

Suppression d'une rubrique

Cette API permet de supprimer une rubrique existante.

Type de requête : DELETE

https://api.dev.rcphotos.fr/api/rubriques/1
Valeurs à fournir
Clé Type Description
id integer Id de la rubrique à supprimer (obligatoire)
Valeurs renvoyées
Clé Type Description
message string Réponse de l'API
articles array Liste des articles associés à la rubrique (si elle en contient)