API : domaines et sous-domaines autorisés

Grâce aux routes suivantes, vous pourrez lire, mettre à jour et supprimer votre domaine par défaut, vos autres domaines et vos sous-domaines via l'API REST. ​

GET /settings/domain

Cette méthode retournera votre domaine actuel par défaut.

URL de la ressource

GET https://app.snipcart.com/api/settings/domain

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.

Exemple de requête

curl -H "Accept: application/json" \
  https://app.snipcart.com/api/settings/domain \
  -u {API_KEY}

Exemple de réponse

{
  "domain":"snipcart.com",
  "protocol":"https"
}

​

PUT /settings/domain

Cette méthode permet de remplacer le domaine par défaut actuel par celui indiqué en paramètre.

URL de la ressource

PUT https://app.snipcart.com/api/settings/domain

En-têtes

Nom	Value	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.
Content-Type	application/json	Oui	Le corps de la requête doit être JSON et nous spécifions donc le type de contenu

Paramètres

Nom	Obligatoire?	Type	Description
Domain	Oui	string	Ce sera votre nouveau domaine par défaut qui sera associé à votre compte.
Protocol	Non, ce sera HTTP par défaut	string	Peut être HTTPS ou HTTP, si elle n'est pas spécifiée ou différente, la valeur par défaut sera HTTP.

​

Exemple de requête ​

curl https://app.snipcart.com/api/settings/domain
  -X PUT \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -u {API_KEY} \
  -d "{'domain': 'snipcartnewdomain.com','protocol': 'https'}"

​ Exemple de réponse

{
  "domain":"snipcartnewdomain.com",
  "protocol":"https"
}

​

GET /settings/alloweddomains

Cette méthode retourne une liste de tous les domaines et sous-domaines autorisés autres que le domaine de votre site web par défaut.

URL de la ressource

GET https://app.snipcart.com/api/settings/alloweddomains

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.

Exemple de requête

curl -H "Accept: application/json" \
  https://app.snipcart.com/api/settings/alloweddomains \
  -u {API_KEY}

​ Exemple de réponse

[{
  "domain":"15ddef3a.ngrok.io",
  "protocol":"http"
},
{
  "domain":"subdomain.snipcart.com",
  "protocol":"https"
}]

​

POST /settings/alloweddomains

Cette méthode AJOUTE les nouveaux domaines ou sous-domaines définis dans le corps.

Notez que la réponse inclura tous les domaines et sous-domaines actuels après avoir ajouté les nouveaux. Le domaine du site web par défaut ne figurera pas dans la réponse.

URL de la ressource

POST https://app.snipcart.com/api/settings/alloweddomains

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.
Content-Type	application/json	Oui	Le corps de la requête doit être JSON et nous spécifions donc le type de contenu

Paramètres

Nom	Obligatoire?	Type	Description
`Array` d'objets {domain: 'value', protocol: 'value'}	Le format `array` est obligatoire. Le domaine est obligatoire. Le protocole n'est pas obligatoire et prendra HTTP comme valeur par défaut.	Array	Les objets représentant une combinaison de domaine et de protocole doivent se trouver dans un `array`, même si vous n'avez qu'un seul domaine à ajouter.

​​

Exemple de requête

curl https://app.snipcart.com/api/settings/alloweddomains \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -u {API_KEY}\
  -d "[{'domain': 'subdomain1.snipcart.com'}, {'domain': 'snipalt.com', 'protocol': 'https'}]"

​ Exemple de réponse

[{
  "domain":"subdomain1.snipcart.com",
  "protocol":"http"
},
{
  "domain":"snipalt.com",
  "protocol":"https"
},
{
  "domain":"subdomain.snipcart.com",
  "protocol":"https"
}]

​

DELETE /settings/alloweddomains

Cette méthode SUPPRIME les domaines ou sous-domaines existants définis dans le corps.

Notez que la réponse inclura tous les domaines et sous-domaines actuels après avoir supprimé ceux qui ont été spécifiés. Le domaine du site web par défaut ne figurera pas dans la réponse. Notez également que si les domaines à supprimer ne sont pas trouvés parmi les domaines actuellement autorisés, nos serveurs retourneront un BadRequest.

URL de la ressource

DELETE https://app.snipcart.com/api/settings/alloweddomains

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.
Content-Type	application/json	Oui	Le corps de la requête doit être JSON et nous spécifions donc le type de contenu

Paramètres

Nom	Obligatoire?	Type	Description
`Array` d'objets {domain: 'value', protocol: 'value'}	Le format `array` est obligatoire. Le domaine est obligatoire. Le protocole n'est pas obligatoire et prendra HTTP comme valeur par défaut.	Array	Les objets représentant une combinaison de domaine et de protocole doivent être dans un `array`, même si vous n'avez qu'un seul domaine à supprimer.

​​​

Exemple de requête

curl https://app.snipcart.com/api/settings/alloweddomains \
    -X Delete \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -u {API_KEY} \
    -d "[{'domain': 'subdomain1.snipcart.com'}, {'domain': 'snipalt.com', 'protocol': 'https'}]"

​ Exemple de réponse

[{
  "domain":"subdomain.snipcart.com",
  "protocol":"https"
}]