API de livraison

L’API de livraison vous fournit des informations sur la façon de « servir une requête ». Cette API est le pilier de l’hébergement d’un blog sur un sous-répertoire.

Point de terminaison de l’API : https://blogs.hyvor.com/api/delivery/v0/{subdomain}

Remplacez {subdomain} par le sous-domaine de votre blog.

Requête

• Requête GET vers le point de terminaison de l’API
• Définissez le paramètre de requête api_key avec une clé API de livraison valide. Vous pouvez en créer une dans Paramètres → Clés API.
• Définissez le paramètre de requête path avec le chemin du blog pour lequel vous souhaitez obtenir des informations. Par exemple, si vous voulez obtenir des informations sur https://myblog.com/hello-world, définissez path sur /hello-world/.

Réponse

Une réponse réussie sera l’un des objets JSON suivants :

1. Fichier

Cet objet est renvoyé lorsque le chemin correspond à un fichier.

{
	"type": "file",
	"at": 1661590503,
	"cache": true,
	"status": 200,
	"file_type": "template",
	"content": "SGVsbG8gV29ybGQ=",
	"mime_type": "text/html",
	"cache_control": "no-cache, private"
}

2. Redirection

Cet objet est renvoyé lorsque le chemin correspond à une redirection.

{
	"type": "redirect",
	"at": 1661590503,
	"cache": true,
	"status": 301,
	"to": "https://example.com"
}

Propriétés communes :

Propriétés du fichier :

Propriétés de redirection :