API REST de capture d'écran • Pagescreen

Commencer

Clés API

Avant de pouvoir commencer à utiliser notre API REST, vérifiez que vous disposez de deux clés d'API (privée et publique). Connectez-vous à votre compte et visitez la section "Intégration".

Authentification

L'authentification est effectuée via transaction sécurisée HTTPS, utilisant vos clés d'API publique et secrète comme nom d'utilisateur et mot de passe.

Par exemple, pour lister vos captures, vous pouvez exécuter la requête suivante :

curl -u {PUBLIC_KEY}:{PRIVATE_KEY} https://api.pagescreen.io/v1/capture.json

Limites

L'authentification et les appels API ne sont pas soumis à limitation pour le moment. Nous pourrions décider de limiter ces accès si le nombre d'opérations est jugé anormalement élevé. N'hésitez pas à nous contacter si vous prévoyez une utilisation importante.

Référence de l'API REST

Account

Vos informations de compte développer

GET

/v1/account.json

Obtenez vos informations de compte

POST

/v1/account.json

Définir les informations de votre compte

GET

/v1/account/access.json

Lister tous les accès partagés à votre compte

POST

/v1/account/access.json

Partagez votre compte avec un nouveau collaborateur

DELETE

/v1/account/access/{id}.json

Révoquer un accès spécifique à votre compte

App

Obtenez des infos et des statistiques récentes sur votre utilisation de Pagesscreen développer

GET

/v1/app/stats.json

Obtenir des statistiques sur vos captures

Automation

Générer des captures à une fréquence spécifique et détecter les changements entre chacune d'entre elles développer

GET

/v1/automation.json

Liste toutes ou une automatisation spécifique

POST

/v1/automation.json

Créer une automatisation

PUT

/v1/automation/{id}.json

Mettre à jour une automatisation

DELETE

/v1/automation/{id}.json

Supprimer une automatisation

POST

/v1/automation/{id}/pause.json

Mettre en pause une automatisation

POST

/v1/automation/{id}/resume.json

Reprendre une automatisation

POST

/v1/automation/{id}/refresh.json

Forcer l'automatisation à générer instantanément une nouvelle capture

PUT

/v1/automation/{id}/template/{template_id}.json

Ajouter un modèle à une automatisation

DELETE

/v1/automation/{id}/template/{template_id}.json

Supprimer un modèle d'une automatisation

GET

/v1/automation/domain.json

Obtenir des statistiques sur les domaines utilisés dans vos automatisations

GET

/v1/automation/{id}/stats.json

Obtenez des statistiques sur un an pour une automatisation

Capture

Prenez une capture d'écran d'une page Web en ligne développer

GET

/v1/capture.json

Liste toutes ou une capture spécifique

Paramètres

optionnel

integer

Identifiant unique d'une capture

automation

optionnel

boolean

Retourne les captures générées par une automatisation

automation_change

optionnel

boolean

Obligatoire avec le paramètre change_threshold

change_threshold

optionnel

integer

Filtre de pourcentage de changement minimum

automation_id

optionnel

integer

Retourne les captures à partir d'une automatisation donnée

latest

optionnel

boolean

Retourne seulement la dernière capture (regroupée par ses spécifications)

fullpage

optionnel

integer

Retourne les captures de pages entières

favorite

optionnel

boolean

Retourne les captures favorites

replaced_by

optionnel

integer

Retourne une capture remplacée par une autre capture

url_id

optionnel

integer

Retourne les captures d'une URL

optionnel

string

Mots-clés

start

optionnel

integer

Décalage

limit

optionnel

integer

Nombre de captures à retournerRègle(s) : 200 max.

from

optionnel

date

Retourne les captures prises après cette date

optionnel

date

Retourne les captures prises avant cette date

Réponse

{ "status": 200, "requestId": "1fa-267917-05af70-6a558b7f", "data": [ { "id": "258635", "url": { "id": "66", "url": "https://spellin.io/", "title": "Spellin", "description": "" }, "permalink": "https://pagescreen.io/i/15hx-7249680f6e6f.png", "generated": "1", "status": "1", "requested_on": "2018-02-12T16:08:13+00:00", "last_updated": "2018-02-12T16:08:22+00:00", "options": { "ttl": "0", "delay": "0", "format": "png", "fullpage": "1", "viewport": { "width": "1280", "height": "∞" } }, "automation_id": "1112", "favorite": false, "faved_on": null, "token": "4705188845a41587c5c7ce105824317d", "change_id": "249534", "change": "0", "change_pct": "0.00", "file": { "width": "1280", "height": "960", "size": "53238" }, "colors": { "rgb(103, 108, 123)": 8, "rgb(255, 255, 255)": 3, "rgba(0, 0, 0, 0)": 11, "rgb(34, 34, 34)": 2, "rgb(255, 65, 54)": 2, "rgb(0, 0, 0)": 2, "rgb(10, 10, 10)": 1, "rgb(238, 238, 238)": 1, "rgb(254, 254, 254)": 1, "rgb(144, 144, 144)": 1, "rgba(0, 0, 0, 0.6)": 1, "rgba(0, 0, 0, 0.3)": 1 } } ] }

POST

/v1/capture.json

Créer une capture

DELETE

/v1/capture/{id}.json

Supprime une capture

GET

/v1/capture/{id}/fave.json

Obtenez les informations de favoris sur la capture

PUT

/v1/capture/{id}/fave.json

Définir une capture spécifique comme favorite

DELETE

/v1/capture/{id}/fave.json

Supprimer une capture des favoris

GET

/v1/capture/{id}/tag.json

Obtenir les mots-clés d'une capture

POST

/v1/capture/{id}/tag.json

Ajouter des mots-clés sur une capture

DELETE

/v1/capture/{id}/tag.json

Supprimer tous les mots-clés d'une capture

GET

/v1/capture/{id}/change.json

Obtenir les informations d'une capture

POST

/v1/capture/{id}/rating.json

Noter la capture

Template

Définir les règles de capture à l'aide de modèles développer

GET

/v1/template.json

Liste le ou les modèle(s)

POST

/v1/template.json

Créer un modèle

PUT

/v1/template/{id}.json

Mettre à jour un modèle

DELETE

/v1/template/{id}.json

Supprimer un modèle

Url

Obtenez des détails et des statistiques sur les URL que vous capturez développer

GET

/v1/url.json

Liste la ou les URL(s)

GET

/v1/url/{id}/stats.json

Obtenir les statistiques concernant une URL

GET

/v1/url/domain.json

Liste des domaines

User

Accéder aux informations des utilisateurs de votre compte développer

GET

/v1/user.json

Liste des informations de base sur les utilisateurs du compte

PUT

/v1/user/{id}.json

Mettre à jour les informations d'un utilisateur

Codes de réponse HTTP

Voici la liste des différents codes de réponse que vous recevrez d'une requête d'API :

200 OK La demande a réussi

204 OK La demande a été acceptée, la ressource a été supprimée

304 NOT MODIFIED Il n'y a pas de nouvelles données à retourner

400 BAD REQUEST La demande est invalide ou ne peut être servie

401 UNAUTHORIZED Les informations d'authentification sont manquantes ou non valides

402 PAYMENT REQUIRED L'abonnement actuel n'autorise pas cette requête

403 FORBIDDEN La demande a été refusée

404 NOT FOUND L'URI demandé est invalide ou la ressource demandée n'existe pas

405 METHOD NOT ALLOWED La méthode spécifiée dans la requête n'est pas autorisée pour la ressource identifiée

500 INTERNAL SERVER ERROR Quelque chose a mal tourné

Types de données

Afin d'effectuer des requêtes et passer la validation, chaque paramètre a un type de données spécifié dans la référence de l'API :

integer -10, 0, 50, 86400

string "Ceci est un exemple de chaîne"

boolean 0, 1, true, yes

date "2018-02-13T23:00:00+00:00"

array ["valeur1", "valeur2"]