Ajouter / retirer des crédits (mail)
- Home
- Ajouter / retirer des crédits (mail)
Ajout de crédit
Depuis votre compte, il vous est possible d’ajouter des crédits sur vos sous comptes. Les crédits seront débités de votre compte principal.
URL
POST https://api.mailpartner.fr/v1/subaccount/credit/add
Paramètres
Chaque demande d’API prend en charge les paramètres suivants :
| apiKey | Clé API de votre compte. Vous l’obtenez dans votre compte MAIL Partner |
|---|---|
| credit | Nombre de crédit en Euro à ajouter au sous-compte. |
| tokenSubaccount | Identifiant du sous compte. |
| Paramètres optionnels | |
| _format | Format de la réponse. Vous pouvez choisir entre JSON ou XML. Par défaut, le format de réponse est JSON. |
Requête
Exemple de requête :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
<?php // Prepare data for POST request $fields = array( 'apiKey'=> 'YOUR API KEY', 'credit'=> '100', 'tokenSubaccount'=>'identifiant du sous-compte' ); $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.mailpartner.fr/v1/subaccount/credit/add'); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_TIMEOUT, 10); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS,json_encode($fields)); $result = curl_exec($curl); curl_close($curl); // Process your response here echo $result; ?> |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
Imports System.IO Imports System.Net Module Module1 Sub Main() Dim base_url As String = "http://api.mailpartner.fr/v1/" Dim apiKey As String = "VOTRE_APIKEY" #send sms url = base_url & "subaccount/credit/sms" #note : utiliser une librairie JSON en production, par exemple : #https//www.nuget.org/packages/Newtonsoft.Json/ Dim parameters As String = String.Format( "{{""apiKey"":""{0}"",""credit"":""{1}"",""tokenSubaccount"":""{2}""}}", apiKey, 50, "identifiant du sous-compte") Console.Write(parameters) apiRequest("POST", url, parameters) End Sub Function apiRequest(method As String, url As String, parameters As String) As String Dim request As HttpWebRequest request = WebRequest.Create(url) request.Method = method request.Timeout = 10000 # timeout in ms request.ContentType = "application/json; charset=utf-8" request.ContentLength = 0 #set POST data If Not String.IsNullOrEmpty(parameters) Then request.ContentLength = parameters.Length Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream()) reqStream.Write(parameters) End Using End If #get response Dim returnValue As String = Nothing Using response As HttpWebResponse = request.GetResponse() If response.StatusCode = HttpStatusCode.OK Then Using resStream = response.GetResponseStream() If resStream IsNot Nothing Then Using reader As New StreamReader(resStream) returnValue = reader.ReadToEnd() End Using End If End Using End If End Using apiRequest = returnValue End Function End Module |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# std import logging import json from collections import OrderedDict # 3p import requests API_KEY = "MY API KEY" URL = "https://api.mailpartner.fr/v1" class MailPartner(): def add_credit(self,creditToAdd,tokenSubaccount): data = OrderedDict([ ("apiKey", API_KEY), ("credit",creditToAdd), ("tokenSubaccount",tokenSubaccount) ]) url = URL + "/subaccount/credit/add" r = requests.post(url, data=json.dumps(data), verify=False) r_json = r.json() if r_json.get("success") == True: print(r_json) status = True else: print(r_json) status = False return status |
|
1 |
curl -H "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","credit":"10","tokenSubaccount":"identifiant du sous-compte"}' https://api.mailpartner.fr/v1/subaccount/credit/add |
Réponses
|
1 2 3 4 5 6 7 |
{ "success": true, "code": 200, "credit": 2869.2, "subaccountCredit": 61.8, "currency": "EUR" } |
|
1 2 3 4 5 6 7 8 9 10 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>true</entry> <entry>200</entry> <entry>2859.2</entry> <entry>71.8</entry> <entry> <![CDATA[EUR]]> </entry> </result> |
Erreurs
Exemple de message d’erreur :
|
1 2 3 4 5 |
{ "success": false, "code": 10, "message": "Clé API incorrecte" } |
|
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>false</entry> <entry>10</entry> <entry> <![CDATA[Clé API incorrecte]]> </entry> </result> |
Code de contrôle
| Réponse | ||
|---|---|---|
| 1 | La Clé API est requise | |
| 2 | Le crédit est requis | |
| 3 | L’identifiant du sous-compte est requis | |
| 4 | Vous n’avez pas l’authorisation | |
| 5 | Le crédit à attribuer doit être supérieur à 0 | |
| 6 | La balance doit être supérieur à 0 | |
| 7 | Le sous-compte n’exsite pas | |
| 8 | Crédits insufisant | |
| 10 | Clé API incorrecte | |
| 200 | Tout s’est bien passé ! | |
Suppression de crédit
Depuis votre compte, il vous est possible de supprimer des crédits de vos sous comptes. Les crédits seront ajoutés à votre compte principal.
URL
POST https://api.mailpartner.fr/v1/subaccount/credit/remove
Paramètres
Chaque demande d’API prend en charge les paramètres suivants :
| apiKey | Clé API de votre compte. Vous l’obtenez dans votre compte Mail Partner |
|---|---|
| credit | Nombre de crédit en Euro à ajouter au sous-compte. |
| tokenSubaccount | Identifiant du sous compte. |
| Paramètres optionnels | |
| _format | Format de la réponse. Vous pouvez choisir entre JSON ou XML. Par défaut, le format de réponse est JSON. |
Requête
Exemple de requête :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
<?php // Prepare data for POST request $fields = array( 'apiKey'=> 'YOUR API KEY', 'credit'=> '100', 'tokenSubaccount'=>'identifiant du sous-compte' ); $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.mailpartner.fr/v1/subaccount/credit/add'); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_TIMEOUT, 10); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS,json_encode($fields)); $result = curl_exec($curl); curl_close($curl); // Process your response here echo $result; ?> |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
Imports System.IO Imports System.Net Module Module1 Sub Main() Dim base_url As String = "http://api.mailpartner.fr/v1/" Dim apiKey As String = "VOTRE_APIKEY" #send sms url = base_url & "subaccount/credit/sms" #note : utiliser une librairie JSON en production, par exemple : #https//www.nuget.org/packages/Newtonsoft.Json/ Dim parameters As String = String.Format( "{{""apiKey"":""{0}"",""credit"":""{1}"",""tokenSubaccount"":""{2}""}}", apiKey, 50, "identifiant du sous-compte") Console.Write(parameters) apiRequest("POST", url, parameters) End Sub Function apiRequest(method As String, url As String, parameters As String) As String Dim request As HttpWebRequest request = WebRequest.Create(url) request.Method = method request.Timeout = 10000 # timeout in ms request.ContentType = "application/json; charset=utf-8" request.ContentLength = 0 #set POST data If Not String.IsNullOrEmpty(parameters) Then request.ContentLength = parameters.Length Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream()) reqStream.Write(parameters) End Using End If #get response Dim returnValue As String = Nothing Using response As HttpWebResponse = request.GetResponse() If response.StatusCode = HttpStatusCode.OK Then Using resStream = response.GetResponseStream() If resStream IsNot Nothing Then Using reader As New StreamReader(resStream) returnValue = reader.ReadToEnd() End Using End If End Using End If End Using apiRequest = returnValue End Function End Module |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# std import logging import json from collections import OrderedDict # 3p import requests API_KEY = "MY API KEY" URL = "https://api.mailpartner.fr/v1" class MailPartner(): def add_credit(self,creditToAdd,tokenSubaccount): data = OrderedDict([ ("apiKey", API_KEY), ("credit",creditToAdd), ("tokenSubaccount",tokenSubaccount) ]) url = URL + "/subaccount/credit/add" r = requests.post(url, data=json.dumps(data), verify=False) r_json = r.json() if r_json.get("success") == True: print(r_json) status = True else: print(r_json) status = False return status |
|
1 |
curl -H "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","credit":"10","tokenSubaccount":"identifiant du sous-compte"}' https://api.mailpartner.fr/v1/subaccount/credit/add |
Réponses
|
1 2 3 4 5 6 7 |
{ "success": true, "code": 200, "credit": 2869.2, "subaccountCredit": 61.8, "currency": "EUR" } |
|
1 2 3 4 5 6 7 8 9 10 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>true</entry> <entry>200</entry> <entry>2859.2</entry> <entry>71.8</entry> <entry> <![CDATA[EUR]]> </entry> </result |
Erreurs
Exemple de message d’erreur :
|
1 2 3 4 5 |
{ "success": false, "code": 10, "message": "Clé API incorrecte" } |
|
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>false</entry> <entry>10</entry> <entry> <![CDATA[Clé API incorrecte]]> </entry> </result> |
Code de contrôle
| Réponse | ||
|---|---|---|
| 1 | La Clé API est requise | |
| 2 | Le crédit est requis | |
| 3 | L’identifiant du sous-compte est requis | |
| 4 | Vous n’avez pas l’authorisation | |
| 5 | Le crédit à attribuer doit être supérieur à 0 | |
| 6 | La balance doit être supérieur à 0 | |
| 7 | Le sous-compte n’exsite pas | |
| 8 | Crédits insufisant | |
| 10 | Clé API incorrecte | |
| 200 | Tout s’est bien passé ! | |
© 2014 - 2023 NDA MEDIA. Tous droits réservés. Mentions légales