API_USER
API_USER est le compte de vérification utilisé pour envoyer des e-mails dans EngageLab.
Vous pouvez rechercher ou ajouter un API_USER via l'API.
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/api_users
Requête (par lot)
Obtenez les informations de base de l'API_USER via cette interface
URL
https://email.api.engagelab.cc/v1/api_users
Méthode de requête HTTP
GET
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| email_type | int | non | type d'e-mail : 0 (déclencheur), 1 (lot) |
| api_user_type | int | non | type d'api_user : 0 (test), 1 (général) |
| domain_name | string | non | nom de domaine lié |
Exemple de requête
curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Description de la valeur retournée
| Champ | Description |
|---|---|
| api_user | API_USER |
| api_user_type | type d'api_user : 0 (test), 1 (général) |
| email_type | type d'e-mail de l'API_USER |
| domain_name | domaine lié à l'API_USER |
| click_tracking | activation du suivi des clics : false (désactivé), true (activé) |
| open_tracking | activation du suivi des ouvertures : false (désactivé), true (activé) |
| unsubscribe_tracking | activation du suivi des désabonnements : false (désactivé), true (activé) |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"result": [
{
"api_user": "xjmfcbatch",
"api_user_type": 1,
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": false
}
],
"count": 85
}
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Échec de l'authentification."
}
Ajouter
API_USER et API_KEY sont les identifiants utilisés pour l'authentification lors de l'appel à l'API d'EngageLab, permettant de distinguer les types d'e-mails déclencheurs et par lot.
Cette API vous permet d'ajouter un API_USER et retourne l'API_KEY correspondante.
Veuillez noter : Avant d'utiliser cette API pour ajouter un API_USER, veuillez vérifier si vous avez déjà créé un API_USER et une API_KEY. Sinon, vous devez vous connecter à l'interface web pour les créer la première fois.
URL
https://email.api.engagelab.cc/v1/api_users
Content-Type :
application/json; charset=utf-8
Méthode de requête HTTP
POST
En-tête de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Description des paramètres du corps
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| api_user | string | oui | nom de l'API_USER |
| email_type | int | oui | type d'e-mail : 0 (déclencheur), 1 (lot) |
| domain_name | string | oui | nom de domaine lié à l'API_USER |
| track_domain_name | string | non | nom de suivi lié à l'API_USER |
| open_tracking | boolean | non | activer le suivi des ouvertures : false (désactivé), true (activé) ; désactivé par défaut |
| click_tracking | boolean | non | activer le suivi des clics : false (désactivé), true (activé) ; désactivé par défaut |
| unsubscribe_tracking | boolean | non | activer le suivi des désabonnements : false (désactivé), true (activé) ; activé par défaut |
Astuces :
1. Le suivi des désabonnements sera forcé et gratuit pour les utilisateurs gratuits
Exemple de requête
curl -X POST "https://email.api.engagelab.cc/v1/api_users"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"api_user":"batch_edm",
"email_type":1,
"domain_name":"aizl.net"
}'
Description de la valeur retournée
| Champ | Description |
|---|---|
| api_user | nom de l'API_USER |
| api_key | API_KEY |
| api_user_type | type d'API_USER |
| email_type | type d'e-mail de l'API_USER |
| domain_name | domaine lié à l'API_USER |
| click_tracking | activation du suivi des clics |
| open_tracking | activation du suivi des ouvertures |
| unsubscribe_tracking | activation du suivi des désabonnements |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"result": {
"api_user": "xjmfcbatch",
"api_user_type": 1,
"api_key": "2*****",
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": true
}
}
Réponse-erreur
HTTP Status :400
{
"code": 31110,
"message": "api_user ne peut pas être vide."
}
