API des Blocs
Si vous rencontrez des inscriptions malveillantes et ne souhaitez pas envoyer d'e-mails à certaines adresses ou boîtes mail, vous pouvez ajouter le domaine ou l'adresse e-mail spécifique à la liste de blocage. Les adresses e-mail présentes dans cette liste seront bloquées par le système. Vous pouvez consulter, ajouter et supprimer des entrées dans cette liste.
Adresse d'appel
| Centre de données | URL |
|---|---|
| Singapour | https://email.api.engagelab.cc |
| Turquie | https://emailapi-tr.engagelab.com |
Lors de l'utilisation de l'API REST, assurez-vous que le centre de données sélectionné correspond à l'URL de base appropriée.
POST/v1/blocks
Requête
URL
https://email.api.engagelab.cc/v1/blocks
https://email.api.engagelab.cc/v1/blocks
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| start_date | string | oui | Date de début, formatée en yyyy-MM-dd |
| end_date | string | oui | Date de fin, formatée en yyyy-MM-dd |
| email_or_domain | string | oui | E-mails ou domaines (ex. : 11@gmail.com, hotmail.com) |
| api_user | string | non | api_user de blocage, par défaut all |
| offset | int | non | Début [0-100], par défaut 100 |
| limit | int | non | Quantité [0-100], par défaut 100 |
Astuces :
- La période ne peut pas dépasser 3 mois.
Exemple de requête :
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/blocks?offset=0&limit=1'
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/blocks?offset=0&limit=1'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| api_user | api_user de blocage |
| email_or_domain | E-mail ou domaine bloqué |
| create_time | Date de création |
| expire_time | Date d'expiration |
Exemple de valeurs retournées
{
"result": [
{
"block_id": 122,
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 123,
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 124,
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
],
"count": 3,
"total": 10
}
{
"result": [
{
"block_id": 122,
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 123,
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 124,
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
],
"count": 3,
"total": 10
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter
URL
https://email.api.engagelab.cc/v1/blocks
https://email.api.engagelab.cc/v1/blocks
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
POST
POST
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres du corps
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| api_user | string | non | api_user de blocage, par défaut all |
| email_or_domain | array | oui | E-mails ou domaines (ex. : ["11@gmail.com","hotmail.com","22@yahoo.com"]) |
| expire_time | string | oui | Date d'expiration, formatée en yyyy-MM-dd |
Exemple de requête :
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/blocks'
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/blocks'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| api_user | api_user de blocage |
| email_or_domain | E-mail ou domaine |
| create_time | Date de création |
| expire_time | Date d'expiration |
Exemple de valeurs retournées
{
"result": [
{
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
]
}
{
"result": [
{
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer des blocs
URL
https://email.api.engagelab.cc/v1/blocks
https://email.api.engagelab.cc/v1/blocks
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
DELETE
DELETE
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres du corps
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| api_user | string | non | api_user de blocage |
| email_or_domain | array | oui | Domaines ou adresses e-mail à bloquer |
Exemple de requête :
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}'
'https://email.api.engagelab.cc/v1/blocks'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}'
'https://email.api.engagelab.cc/v1/blocks'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | Nombre d'éléments supprimés avec succès |
Exemple de valeurs retournées
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
